Create an API Gateway
Create an API Gateway in the Konnect Organization.
Body
application/json
Body
CreateGatewayRequest
The request schema for the create gateway request.
The name of the Gateway.
>= 1 characters<= 255 characters
A human-readable description of the Gateway.
<= 512 characters
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
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
Response
A response to creating a gateway.
APIGatewayInfo
The gateway object contains information about a Konnect gateway.
The gateway ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the Gateway.
>= 1 characters<= 255 characters
A human-readable description of the Gateway.
<= 512 characters
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"}
An ISO-8604 timestamp representation of gateway creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8604 timestamp representation of gateway update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Body
Get API Gateway
Returns information about an individual API gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A response to retrieving a single API gateway.
APIGatewayInfo
The gateway object contains information about a Konnect gateway.
The gateway ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the Gateway.
>= 1 characters<= 255 characters
A human-readable description of the Gateway.
<= 512 characters
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"}
An ISO-8604 timestamp representation of gateway creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8604 timestamp representation of gateway update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update API Gateway
Update an individual gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
UpdateGatewayRequest
The request schema for the update gateway request.
The name of the Gateway.
>= 1 characters<= 255 characters
A human-readable description of the Gateway.
<= 512 characters
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
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
Response
A response to updating a gateway.
APIGatewayInfo
The gateway object contains information about a Konnect gateway.
The gateway ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the Gateway.
>= 1 characters<= 255 characters
A human-readable description of the Gateway.
<= 512 characters
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"}
An ISO-8604 timestamp representation of gateway creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8604 timestamp representation of gateway update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete API Gateway
Delete an individual gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
No Content
Authentication
Path Parameters
List API Gateway Listeners
Returns a list of listeners associated with the specified API Gateway.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Filter documents returned in the response.
Show Child Parameters
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A paginated list response for a collection of API Gateway Listeners.
Pagination metadata.