Create a new API Gateway Route
Create a new API Gateway Route
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The route to be created
APIGatewayRouteModify
The name of the API Gateway Route.
>= 1 characters<= 255 characters
A human-readable description of the route.
The path to match for the route.
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"}
Any OfA reference to an existing service by ID.
Show Child Parameters
Response
application/json
Response
The created route.
APIGatewayRoute
The name of the API Gateway Route.
>= 1 characters<= 255 characters
A human-readable description of the route.
The path to match for the route.
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.
A reference to an existing service by ID.
Show Child Parameters
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 route
Get route
Path Parameters
The ID of the API Gateway Route.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
The requested route.
APIGatewayRoute
The name of the API Gateway Route.
>= 1 characters<= 255 characters
A human-readable description of the route.
The path to match for the route.
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.
A reference to an existing service by ID.
Show Child Parameters
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 route
Update a route
Path Parameters
The ID of the API Gateway Route.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The route to be updated
APIGatewayRouteModify
The name of the API Gateway Route.
>= 1 characters<= 255 characters
A human-readable description of the route.
The path to match for the route.
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"}
Any OfA reference to an existing service by ID.
Show Child Parameters
Response
application/json
Response
The updated route.
APIGatewayRoute
The name of the API Gateway Route.
>= 1 characters<= 255 characters
A human-readable description of the route.
The path to match for the route.
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.
A reference to an existing service by ID.
Show Child Parameters
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 route
Delete a route
Path Parameters
The ID of the API Gateway Route.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Success
Authentication
Path Parameters
List all policies for an API Gateway route
List all inbound policies for an API Gateway route
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
The ID of the parent policy.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Path Parameters
The ID of the API Gateway Route.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
200 application/json
Response
A paginated list response for a collection of API Gateway Inbound Policies.
APIGatewayPolicyList
A policy that can be applied to an API Gateway.
Show Child Parameters
Pagination metadata.