deployedApiPlanUpdate

Updates an existing plan.

Input Parameters:

• deployedApiPlan: Plan update configuration including ID and modified fields for rate limits, quotas, and settings.

Response:

• Returns the updated DeployedApiPlan object with modified configuration.

Example Request:

mutation deployedApiPlanUpdate($deployedApiPlan: DeployedApiPlanUpdateInput!) {
    deployedApiPlanUpdate(deployedApiPlan: $deployedApiPlan) {
        id,
        name,
        description,
        applicationCount,
        rateLimit,
        rateLimitPeriod,
        quotaLimit,
        quotaLimitPeriod,
        quotaLimitTimezone,
        maxMessageSize
    }
}

Variables:

{
    "deployedApiPlan": {
        "id": "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
        "rateLimit": 20,
        "rateLimitPeriod": "HOUR"
    }
}

deployedApiPlanUpdate(
  deployedApiPlan: DeployedApiPlanUpdateInput!
): DeployedApiPlan!

Arguments

deployedApiPlanUpdate.deployedApiPlan ● DeployedApiPlanUpdateInput! non-null input platform

Type

DeployedApiPlan object platform

Represents an API plan with rate limiting, quota management, and message size restrictions.