APIGatewayRoute

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"}

idstring(uuid)required

The ID of the service.

default_serviceobject

A reference to an existing service by ID.

Show Child Parameters
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

APIGatewayRouteModify

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"}

default_serviceAny Of
APIGatewayServiceReferenceByIdobject

A reference to an existing service by ID.

Show Child Parameters
Example

APIGatewayServiceReference

object

A reference to an existing service by ID.

idstring(uuid)required

The ID of the service

namestringrequired

The name identifier of the service

>= 1 characters<= 255 characters

Example

APIGatewayServiceReferenceModify

A reference to an existing service, either by ID or by name.

Any Of
idstring(uuid)required

The ID of the service

Example

APIGatewayServiceReferenceById

object

A reference to an existing service by ID.

idstring(uuid)required

The ID of the service

Example