deployedApi

Returns DeployedApi with the specified id.

Input Parameters:

• id: ID of the deployed API to retrieve.

Response: DeployedApi object containing the complete deployment details, environment, component, and metadata.

Example Request:

query {
    deployedApi(id: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>") {
        id,
        component {
            id,
            name,
            type,
            version,
            definition
        },
        metadata {
            title,
            version,
            description
        },
        authSource {
            id,
            name,
            description,
            roles {
                id,
                name,
                description
            }
        },
        environment {
            id,
            name,
            gateway {
                id,
                name,
                deleted,
                defaultApiExecutionSettings {
                    concurrency,
                    retries,
                    connectTimeout,
                    executionTimeout,
                    retryCases,
                    subscriptionCacheSize
                }
            },
            settings {
                restPath,
                soapPath,
                soap12Path,
                odataPath
            },
            publishedName
        },
        endpoints {
            type,
            basePath
        },
        keylessPlan {
            id,
            name,
            description,
            status,
            maxMessageSize,
            rateLimit,
            rateLimitPeriod,
            quotaLimit,
            quotaLimitPeriod,
            quotaLimitTimezone,
            applicationCount
        },
        plans {
            id,
            name,
            description,
            status,
            maxMessageSize,
            rateLimit,
            rateLimitPeriod,
            quotaLimit,
            quotaLimitPeriod,
            quotaLimitTimezone,
            applicationCount
        },
        executionSettings {
            concurrency,
            retries,
            connectTimeout,
            executionTimeout,
            retryCases,
            subscriptionCacheSize
        },
        requiredRoles {
            id,
            name,
            description
        },
        customPolicies {
            path,
            when,
            rules {
                id,
                name,
                description,
                methods,
                type,
                configuration,
                usedBy {
                    id
                },
                scope
            }
        },
        subscriptions {
            apiKeyId,
            deployedApi {
                id,
                version
            },
            application {
                id,
                name,
                status,
                ownerName,
                ownerUserName,
                ownerEmail,
                contactPhone,
                companyName,
                companyWebsite,
                notes,
                description
            },
            plan {
                id,
                name,
                description,
                status,
                maxMessageSize,
                rateLimit,
                rateLimitPeriod,
                quotaLimit,
                quotaLimitPeriod,
                quotaLimitTimezone,
                applicationCount
            },
            status,
            startDate,
            expirationDate,
            approvalDate,
            consumerMessage,
            producerMessage,
            generatedBy,
            generatedDate,
            statusChangedBy,
            statusChangedDate
        },
        planMappings {
            id,
            plan {
                id,
                name,
                description,
                status,
                maxMessageSize,
                rateLimit,
                rateLimitPeriod,
                quotaLimit,
                quotaLimitPeriod,
                quotaLimitTimezone,
                applicationCount
            },
            apis {
                id,
                version
            }
        },
        version,
        documentation {
            oas,
            wsdl,
            odataOperations {
                name,
                description
            }
        },
        cors {
            origins,
            methods,
            headers,
            allowCredentials,
            maxAge,
            exposeHeaders,
            enableCors,
            runPolicies
        },
        certificateAuthentication {
            certificateAuthRequired,
            trustedX500Names {
                id,
                name,
                description,
                x500Name
            }
        },
        customPolicyPathMode
    }
}

deployedApi(
  id: ID!
): DeployedApi!

Arguments

deployedApi.id ● ID! non-null scalar miscellaneous

Type

DeployedApi object platform

Represents an API deployed to a specific environment and the various information associated with it (Component, ApiComponentMetadata, Environment, DeployedApiEndpoint, Keyless Plan, number of plans associated with Deployed Api, Execution Settings and required roles)