Gateway

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

type Gateway {
  id: ID!
  name: String!
  deleted: Boolean!
  externalUrl: String
  effectivePublicUrl: String!
  externalHealthCheckPath: String
  environments: [Environment]
  defaultApiExecutionSettings: DeployedApiExecutionSettings
  forwardProxy: ForwardProxy
  account: Account!
  gatewayType: GatewayType
  version: Long!
  cors: DeployedApiCors
  certificateAuthentication: GatewayCertificateAuthentication
  internalSslEnabled: Boolean!
  otelConfig: OtelConfiguration
}

Fields

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

Gateway.name ● String! non-null scalar miscellaneous {#name}

The name of the gateway.

Gateway.deleted ● Boolean! non-null scalar miscellaneous {#deleted}

Whether the gateway has been marked as deleted.

Gateway.externalUrl ● String scalar miscellaneous {#external-url}

The external URL for accessing the gateway.

Gateway.effectivePublicUrl ● String! non-null scalar miscellaneous {#effective-public-url}

The effective public URL for this gateway. This may be the same as the externalUrl, but if that has not been specified then this will contain a best-effort determination of the URL which should be used to access this gateway.

Gateway.externalHealthCheckPath ● String scalar miscellaneous {#external-health-check-path}

The path for external health check monitoring.

Gateway.environments ● [Environment] list object platform {#environments}

The environments associated with this gateway.

Gateway.defaultApiExecutionSettings ● DeployedApiExecutionSettings object platform {#default-api-execution-settings}

Default execution settings for APIs deployed on this gateway.

Gateway.forwardProxy ● ForwardProxy object platform {#forward-proxy}

Forward proxy configuration for this gateway.

Gateway.account ● Account! non-null object platform {#account}

The account that owns this gateway.

Gateway.gatewayType ● GatewayType enum platform {#gateway-type}

The type of gateway (provisioned or embedded).

Gateway.version ● Long! non-null scalar platform {#version}

The version number of the gateway.

Gateway.cors ● DeployedApiCors object platform {#cors}

CORS configuration for the gateway.

Gateway.certificateAuthentication ● GatewayCertificateAuthentication object platform {#certificate-authentication}

Certificate authentication settings for the Gateway

Gateway.internalSslEnabled ● Boolean! non-null scalar miscellaneous {#internal-ssl-enabled}

Returns true if SSL is enabled on the gateway.

Gateway.otelConfig ● OtelConfiguration object platform {#otel-config}

OpenTelemetry configuration for gateway telemetry data collection

Returned By

gateway query ●  gatewayProvisionedCreate mutation ●  gateways query ●  gatewayUpdate mutation

Member Of

DeployedApiApplication object ●  DeployedApiCallDetailData object ●  DeployedApiCallSummaryData object ●  DevPortal object ●  Environment object ●  EnvironmentMigration object

Implemented By

_Entity union