Get API Gateway

Returns information about an individual API gateway.

get

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

A response to retrieving a single API gateway.

APIGatewayInfo

The gateway object contains information about a Konnect gateway.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The gateway ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The name of the Gateway.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the Gateway.

<= 512 characters

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

created_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of gateway creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of gateway update date.

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

get/api-gateways/{gatewayId}
 
application/json

Update API Gateway

Update an individual gateway.

put

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

UpdateGatewayRequest

The request schema for the update gateway request.

* Additional properties are NOT allowed.
namestring

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 not be updated.

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

Response

application/json

A response to updating a gateway.

APIGatewayInfo

The gateway object contains information about a Konnect gateway.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The gateway ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The name of the Gateway.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the Gateway.

<= 512 characters

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

created_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of gateway creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of gateway update date.

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

put/api-gateways/{gatewayId}

Body

{}
 
application/json

Delete API Gateway

Delete an individual gateway.

delete

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

No Content

delete/api-gateways/{gatewayId}
 

List API Gateway Listeners

Returns a list of listeners associated with the specified API Gateway.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter documents returned in the response.

Show Child Parameters

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

A paginated list response for a collection of API Gateway Listeners.

metaobject

Pagination metadata.

Show Child Parameters
dataarray
* Additional properties are NOT allowed.
get/api-gateways/{gatewayId}/listeners
 
application/json

Create API Gateway Listener

Creates a new listener associated with the specified API Gateway.

post

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

The http listener to be created

BaseAPIGatewayListener

* Additional properties are NOT allowed.
namestringrequired

The unique name of the listener.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the listener.

portintegerrequired

The port number of the API Gateway listener.

>= 1<= 65535

protocolstringrequired

The protocol used by the listener.

Allowed values:httphttps

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

Response

application/json

Created

APIGatewayListener

APIGatewayListenerobject
* Additional properties are NOT allowed.
post/api-gateways/{gatewayId}/listeners

Body

{ "name": "name", "port": 0, "protocol": "http" }
 
application/json