Update an outbound policy for a service
Update an outbound policy for a service
Path Parameters
The ID of the API Gateway Policy.
The ID of the API Gateway Service.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The outbound policy to be updated
CreateAPIGatewayServiceOutboundPolicy
One OfThe type identifier of the policy
Allowed values:policy_chain_reference
The name identifier of the policy
One OfReference a policy chain by its unique identifier.
Show Child Parameters
A string containing the boolean expression that determines whether the policy is applied.
>= 1 characters<= 1000 characters
Example:context.introspect_token.claims.gold_tier == true
The unique identifier of the parent policy, if any.
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
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
An API Gateway policy
APIGatewayPolicy
A policy that can be applied to an API Gateway.
The ID of the policy
The type identifier of the policy
The name of the policy
The configuration of the policy
The unique identifier of the parent policy, if any.
A string containing the boolean expression that determines whether the policy is applied.
>= 1 characters<= 1000 characters
Example:context.introspect_token.claims.gold_tier == true
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
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"}
Authentication
Path Parameters
Body
Delete an outbound policy for a service
Delete an outbound policy for a service
Path Parameters
The ID of the API Gateway Policy.
The ID of the API Gateway Service.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Success
Authentication
Path Parameters
Move Outbound Policy
Moves the position of a specific outbound policy relative to the chain associated with the API Gateway service.
Query Parameters
The index position of the policy.
>= 0
Example:10
Path Parameters
The ID of the API Gateway Policy.
The ID of the API Gateway Service.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Position Updated
Authentication
Path Parameters
Query Parameters
List all API Gateway Routes
List all API Gateway Routes
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 Routes
Pagination metadata.
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
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