APIGatewayListenerPort

integer

The port number of the API Gateway listener.

>= 1<= 65535

APIGatewayListenerProtocol

string

The protocol used by the listener.

Allowed values:httphttps

BaseAPIGatewayService

object
namestringrequired

The unique name of the API Gateway Service.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the service.

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

Example

APIGatewayService

namestringrequired

The unique name of the API Gateway Service.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the service.

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

idstring(uuid)required

The ID of the service.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

BaseAPIGatewayRoute

object
namestringrequired

The name of the API Gateway Route.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the route.

pathstringrequired

The path to match for the route.

labelsobject

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

Example