List all API Gateway Services
List all API Gateway Services
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
200 application/json
Response
List of API Gateway Services
Pagination metadata.
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create a new API Gateway Service
Create a new API Gateway Service
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The service to be created
BaseAPIGatewayService
The unique name of the API Gateway Service.
>= 1 characters<= 255 characters
A human-readable description of the service.
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
The created service.
APIGatewayService
The unique name of the API Gateway Service.
>= 1 characters<= 255 characters
A human-readable description of the service.
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"}
The ID of the service.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Get a service
Get service
Path Parameters
The ID of the API Gateway Service.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
The requested service.
APIGatewayService
The unique name of the API Gateway Service.
>= 1 characters<= 255 characters
A human-readable description of the service.
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"}
The ID of the service.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update a service
Update a service
Path Parameters
The ID of the API Gateway Service.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The service to be updated
BaseAPIGatewayService
The unique name of the API Gateway Service.
>= 1 characters<= 255 characters
A human-readable description of the service.
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
The updated service.
APIGatewayService
The unique name of the API Gateway Service.
>= 1 characters<= 255 characters
A human-readable description of the service.
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"}
The ID of the service.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete a service
Delete a service
Path Parameters
The ID of the API Gateway Service.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Success