Waiting for engine...
Skip to main content

DeployedApiPlanUpdateInput

Input type for updating an existing deployed API plan.

input DeployedApiPlanUpdateInput {
  id: ID!
  name: String
  description: String
  maxMessageSize: Long
  rateLimit: Long
  rateLimitPeriod: DeployedApiPlanPeriod
  quotaLimit: Long
  quotaLimitPeriod: DeployedApiPlanPeriod
  status: DeployedApiPlanStatusUpdate
}

Fields​

DeployedApiPlanUpdateInput.id ● ID! non-null scalar miscellaneous

The unique identifier of the plan

DeployedApiPlanUpdateInput.name ● String scalar miscellaneous

Name of the plan. If not provided, the current value is retained.

DeployedApiPlanUpdateInput.description ● String scalar miscellaneous

Description of the plan. If not provided, the current value is retained.

DeployedApiPlanUpdateInput.maxMessageSize ● Long scalar partner-portal

Restricts the size of incoming API requests to the number of kilobytes (KB) specified. Setting this to 0 allows a request of any size. Cannot be larger than 1000000000000. If not provided, the current value is retained.

DeployedApiPlanUpdateInput.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, then the actual rate limit could be up to 2*5 = 10. If this field is set to null or 0, the rate limit will be unlimited. Negative numbers are not allowed. If rateLimit is set, rateLimitPeriod is required, except if the rateLimit is set to 0 or null to allow unlimited rate. If not provided, the current value is retained.

DeployedApiPlanUpdateInput.rateLimitPeriod ● DeployedApiPlanPeriod enum platform

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

DeployedApiPlanUpdateInput.quotaLimit ● Long scalar partner-portal

Restricts the number of incoming requests for a specified time period per Environment. Setting it to null or 0 allows an unlimited number of calls up to the limit set on the Environment when it is configured. If quotaLimit is set, quotaLimitPeriod is required, except if the quotaLimit is set to 0 or null to allow unlimited quota. If not provided, the current value is retained.

DeployedApiPlanUpdateInput.quotaLimitPeriod ● DeployedApiPlanPeriod enum platform

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

DeployedApiPlanUpdateInput.status ● DeployedApiPlanStatusUpdate enum platform

The status of the plan. Allowed values are ENABLED, DISABLED. If not provided, the current value is retained.

Member Of​

deployedApiPlanUpdate mutation

On this Page