GatewayName

string

The name of the Gateway.

>= 1 characters<= 255 characters

GatewayDescription

string

A human-readable description of the Gateway.

<= 512 characters

Labels

object

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

MinRuntimeVersion

string

The minimum runtime version supported by the API. This is the lowest version of the data plane
release that can be used with the entity model.
When not specified, the minimum runtime version will be pinned to the latest available release.

Match pattern:^\d+\.\d+$

Example

CreateGatewayRequest

object

The request schema for the create gateway request.

* Additional properties are NOT allowed.
namestringrequired

The name of the Gateway.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the Gateway.

<= 512 characters

min_runtime_versionstring

The minimum runtime version supported by the API. This is the lowest version of the data plane
release that can be used with the entity model.
When not specified, the minimum runtime version will be pinned to the latest available release.

Match pattern:^\d+\.\d+$

Example:1.1

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