gateway

Returns the Gateway that matches the specified Gateway ID.

Input Parameters:

• id: ID of the gateway to retrieve.

Response: Gateway object with complete configuration including environments and proxy settings.

Example Request:

query {
    gateway(id: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>") {
        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,
            name,
            status
        },
        gatewayType,
        version,
        cors {
            origins,
            methods,
            headers,
            allowCredentials,
            maxAge,
            exposeHeaders,
            enableCors,
            runPolicies
        },
        certificateAuthentication {
            certificateHeaderAuthEnabled,
            certificateHeaderName,
            certificateAuthRequired
        },
        internalSslEnabled,
        otelConfig {
            enabled,
            endpoint,
            compression,
            trace,
            metric,
            log,
            ssl
        }
    }
}

gateway(
  id: ID!
): Gateway

Arguments

gateway.id ● ID! non-null scalar miscellaneous

Type

Gateway object platform

Represents Gateway details (Name, Gateway Status, Environment, Api Execution Settings and Forward proxy)