DeployedApiPlan

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

type DeployedApiPlan {
  id: ID!
  name: String
  description: String
  status: DeployedApiPlanStatus
  maxMessageSize: Long
  rateLimit: Long
  rateLimitPeriod: DeployedApiPlanPeriod
  quotaLimit: Long
  quotaLimitPeriod: DeployedApiPlanPeriod
  quotaLimitTimezone: String
  applicationCount: Int!
}

Fields

DeployedApiPlan.id ● ID! non-null scalar miscellaneous

Returns the plan's GUID. Required for the deployedApiPlanUpdate operation.

DeployedApiPlan.name ● String scalar miscellaneous

Mandatory field. Indicates the name of the plan. If not provided in the deployedApiPlanUpdate operation, the existing value remains unchanged.

DeployedApiPlan.description ● String scalar miscellaneous

A description of the plan. If not provided in the deployedApiPlanUpdate operation, the current value is retained.

DeployedApiPlan.status ● DeployedApiPlanStatus enum platform

ENABLED, DELETED, and DISABLED. DISABLED plans can’t be added to any deployment and no new subscriptions can be created for existing deployments that use the plan. If not provided in the deployedApiPlanUpdate operation, the current value is retained.

DeployedApiPlan.maxMessageSize ● Long scalar partner-portal

Restricts the size of incoming API requests to the number of kilobytes (KB) specified. Omitting the field, or setting it to null allows a request of any size. Cannot be larger than 1000000000000. If not provided in the deployedApiPlanUpdate operation, the current value is retained.

DeployedApiPlan.rateLimit ● Long scalar partner-portal

Rate limit is per node and restricts the number of incoming requests for a specified time period per Gateway. For a 2 node gateway, if you set the rate limit as 5, the actual rate limit could be up to 2*5 = 10. If this field is omitted or set to null, the rate limit is unlimited. Negative numbers are not allowed. If rateLimit is set, rateLimitPeriod is required, unless the rateLimit is set to 0 or null to allow an unlimited rate. If not provided in the deployedApiPlanUpdate operation, the current value is retained.

DeployedApiPlan.rateLimitPeriod ● DeployedApiPlanPeriod enum platform

Allowed values are SECOND, MINUTE, HOUR. Required if rateLimit is set to a non-zero value.

DeployedApiPlan.quotaLimit ● Long scalar partner-portal

Restricts the number of incoming requests for a specified time period per environment. Omitting the field or setting it to null allows an unlimited number of calls up to the limit set on the environment when it is configured. If the quotaLimit is set, then quotaLimitPeriod is required, unless the quotaLimit is set to zero or null to allow for an unlimited quota. If not provided in the deployedApiPlanUpdate operation, the current value is retained.

DeployedApiPlan.quotaLimitPeriod ● DeployedApiPlanPeriod enum platform

Allowed values are DAY, WEEK, MONTH. Required if quotaLimit is set to a non-zero value.

DeployedApiPlan.quotaLimitTimezone ● String scalar miscellaneous

Timezone considered for quota evaluation. Defaults to UTC.

DeployedApiPlan.applicationCount ● Int! non-null scalar miscellaneous

Number of active applications with active subscriptions using this plan.