deployedApiApplication

Returns the Deployed API Application that matches the specified Application ID.

Input Parameters:

• id: ID of the deployed API application to retrieve.

Response: DeployedApiApplication object with complete application details including subscriptions and gateway information.

Example Request:

query {
    deployedApiApplication(id: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>") {
        id,
        name,
        gateway {
            id,
            name,
            deleted,
            externalUrl,
            externalHealthCheckPath,
            environments {
                id,
                name,
                publishedName,
                classification
            },
            defaultApiExecutionSettings {
                concurrency,
                retries,
                retryCases,
                connectTimeout,
                executionTimeout,
                subscriptionCacheSize
            },
            forwardProxy {
                id,
                enabled,
                hostAddress,
                portNumber,
                proxyType,
                username,
                password
            },
            account {
                id
            },
            gatewayType,
            version,
            cors {
                origins,
                methods,
                headers,
                allowCredentials,
                maxAge,
                exposeHeaders,
                enableCors,
                runPolicies
            },
            certificateAuthentication {
                certificateAuthRequired,
                trustedX500Names {
                    id,
                    name,
                    description,
                    x500Name
                }
            },
            internalSslEnabled,
            token,
            otelConfig {
                enabled,
                endpoint,
                compression
            }
        },
        status,
        ownerName,
        ownerUserName,
        ownerEmail,
        contactPhone,
        companyName,
        companyWebsite,
        notes,
        description,
        subscriptions {
            apiKeyId,
            deployedApi {
                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
                },
                endpoints {
                    type,
                    basePath,
                    contextPath,
                    defaultContextPath
                }
            },
            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
        }
    }
}

deployedApiApplication(
  id: ID!
): DeployedApiApplication!

Arguments

deployedApiApplication.id ● ID! non-null scalar miscellaneous {#id}

Type

DeployedApiApplication object platform

type definitions

An API Key is generated for each subscription of the Application so that users can be authorized for specific API access.