Waiting for engine...
Skip to main content

DeployedApiPlanCreateInput

Input parameters for creating a plan.

input DeployedApiPlanCreateInput {
  name: String!
  description: String
  maxMessageSize: Long
  rateLimit: Long
  rateLimitPeriod: DeployedApiPlanPeriod
  quotaLimit: Long
  quotaLimitPeriod: DeployedApiPlanPeriod
}

Fields​

DeployedApiPlanCreateInput.name ● String! non-null scalar miscellaneous

Name of the plan, required.

DeployedApiPlanCreateInput.description ● String scalar miscellaneous

Description of the plan.

DeployedApiPlanCreateInput.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.

DeployedApiPlanCreateInput.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 omitted or set to null, 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.

DeployedApiPlanCreateInput.rateLimitPeriod ● DeployedApiPlanPeriod enum platform

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

DeployedApiPlanCreateInput.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 quotaLimit is set, quotaLimitPeriod is required, except if the quotaLimit is set to 0 or null to allow unlimited quota.

DeployedApiPlanCreateInput.quotaLimitPeriod ● DeployedApiPlanPeriod enum platform

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

Member Of​

deployedApiPlanCreate mutation

On this Page