deployedApiPlanCreate

Creates a Plan. Plan Name is mandatory field and return DeployedApiPlan if the operation is successful.

Input Parameters:

• createPlan: Plan configuration including name, description, rate limits, quotas, and message size restrictions.

Response:

• Returns the created DeployedApiPlan object with complete plan configuration.

Example Request:

mutation deployedApiPlanCreate($createPlan: DeployedApiPlanCreateInput!) {
    deployedApiPlanCreate(createPlan: $createPlan) {
        id,
        name,
        description,
        status,
        maxMessageSize,
        rateLimit,
        rateLimitPeriod,
        quotaLimit,
        quotaLimitPeriod,
        quotaLimitTimezone,
        applicationCount
    }
}

Variables:

{
    "createPlan": {
        "name": "try",
        "maxMessageSize": 1000000000000,
        "rateLimit": 900,
        "rateLimitPeriod": "HOUR",
        "quotaLimit": 90,
        "quotaLimitPeriod": "DAY"
    }
}

Sample Response:

{
    "data": {
        "deployedApiPlanCreate": {
            "id": "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
            "name": "try",
            "description": null,
            "status": "ENABLED",
            "maxMessageSize": 1000000000000,
            "rateLimit": 0,
            "rateLimitPeriod": "SECOND",
            "quotaLimit": 90,
            "quotaLimitPeriod": "DAY",
            "quotaLimitTimezone": "UTC",
            "applicationCount": 0
        }
    }
}

deployedApiPlanCreate(
  createPlan: DeployedApiPlanCreateInput!
): DeployedApiPlan!

Arguments

deployedApiPlanCreate.createPlan ● DeployedApiPlanCreateInput! non-null input platform

Type

DeployedApiPlan object platform

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