deployedApiPlans

Returns all non-deleted API Plans.

Input Parameters:

• filter: Optional filter criteria to limit results by gateway ID.

Response: Array of DeployedApiPlan objects with plan details including rate limits and quotas.

Example Request:

query {
    deployedApiPlans(filter: {gatewayId: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>"}) {
        id,
        name,
        description,
        status,
        maxMessageSize,
        rateLimit,
        rateLimitPeriod,
        quotaLimit,
        quotaLimitPeriod,
        quotaLimitTimezone,
        applicationCount,
        apiMappings {
            id,
            plan {
                id,
                name,
                description,
                status,
                maxMessageSize,
                rateLimit,
                rateLimitPeriod,
                quotaLimit,
                quotaLimitPeriod,
                quotaLimitTimezone,
                applicationCount
            },
            apis {
                id,
                version,
                component {
                    id,
                    name,
                    type,
                    version,
                    definition,
                    folderLocation,
                    deleted,
                    latestVersion
                },
                metadata {
                    title,
                    version,
                    description,
                    publisher {
                        name,
                        email,
                        url
                    },
                    license {
                        title,
                        infoUrl,
                        tosUrl
                    },
                    apiProxyServerUrl,
                    apiPackagedComponentVersion,
                    componentType
                },
                authSource {
                    id,
                    name,
                    description,
                    roles {
                        id,
                        name,
                        description
                    }
                },
                environment {
                    id,
                    name,
                    publishedName,
                    classification,
                    gateway {
                        id,
                        name,
                        deleted,
                        externalUrl,
                        gatewayType,
                        version
                    }
                },
                endpoints {
                    type,
                    basePath,
                    contextPath,
                    defaultContextPath
                },
                executionSettings {
                    concurrency,
                    retries,
                    retryCases,
                    connectTimeout,
                    executionTimeout,
                    subscriptionCacheSize
                }
            }
        }
    }
}

deployedApiPlans(
  filter: DeployedApiPlanFilter
): [DeployedApiPlan!]

Arguments

deployedApiPlans.filter ● DeployedApiPlanFilter input platform

Type

DeployedApiPlan object platform

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