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

Gateway.name ● String! non-null scalar miscellaneous

The name of the gateway.

Gateway.deleted ● Boolean! non-null scalar miscellaneous

Whether the gateway has been marked as deleted.

Gateway.externalUrl ● String scalar miscellaneous

The external URL for accessing the gateway.

Gateway.effectivePublicUrl ● String! non-null scalar miscellaneous

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

The path for external health check monitoring.

Gateway.environments ● [Environment] list object event-streams-query

The environments associated with this gateway.

Gateway.defaultApiExecutionSettings ● DeployedApiExecutionSettings object platform

Default execution settings for APIs deployed on this gateway.

Gateway.forwardProxy ● ForwardProxy object platform

Forward proxy configuration for this gateway.

Gateway.account ● Account! non-null object event-streams-query

The account that owns this gateway.

Gateway.gatewayType ● GatewayType enum platform

The type of gateway (provisioned or embedded).