Update an outbound policy for a service

Update an outbound policy for a service

put

Path Parameters

apiGatewayPolicyIdstring(uuid)required

The ID of the API Gateway Policy.

apiGatewayServiceIdstring(uuid)required

The ID of the API Gateway Service.

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Body

application/json

The outbound policy to be updated

CreateAPIGatewayServiceOutboundPolicy

CreateAPIGatewayServiceOutboundPolicy
One Of
idstring(uuid)read-only
typestringrequired

The type identifier of the policy

Allowed values:policy_chain_reference

namestring

The name identifier of the policy

configOne Of
required
PolicyChainReferenceByIdobject

Reference a policy chain by its unique identifier.

* Additional properties are NOT allowed.
Show Child Parameters
conditionstring

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

parent_policy_idstring | null(uuid)

The unique identifier of the parent policy, if any.

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

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

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

An API Gateway policy

APIGatewayPolicy

A policy that can be applied to an API Gateway.

* Additional properties are NOT allowed.
idstring(uuid)required

The ID of the policy

typestringrequired

The type identifier of the policy

namestring

The name of the policy

configobjectrequired

The configuration of the policy

parent_policy_idstring | null(uuid)

The unique identifier of the parent policy, if any.

conditionstring

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

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

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

put/api-gateways/{gatewayId}/services/{apiGatewayServiceId}/outbound-policies/{apiGatewayPolicyId}

Body

{}
 
application/json

Delete an outbound policy for a service

Delete an outbound policy for a service

delete

Path Parameters

apiGatewayPolicyIdstring(uuid)required

The ID of the API Gateway Policy.

apiGatewayServiceIdstring(uuid)required

The ID of the API Gateway Service.

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Response

Success

delete/api-gateways/{gatewayId}/services/{apiGatewayServiceId}/outbound-policies/{apiGatewayPolicyId}
 

Move Outbound Policy

Moves the position of a specific outbound policy relative to the chain associated with the API Gateway service.

post

Query Parameters

indexintegerrequired

The index position of the policy.

>= 0

Example:10

Path Parameters

apiGatewayPolicyIdstring(uuid)required

The ID of the API Gateway Policy.

apiGatewayServiceIdstring(uuid)required

The ID of the API Gateway Service.

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Response

Position Updated

post/api-gateways/{gatewayId}/services/{apiGatewayServiceId}/outbound-policies/{apiGatewayPolicyId}/move
 

List all API Gateway Routes

List all API Gateway Routes

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

200 application/json

List of API Gateway Routes

* Additional properties are NOT allowed.
metaobjectrequired

Pagination metadata.

Show Child Parameters
dataarrayrequired
Show Child Parameters
get/api-gateways/{gatewayId}/routes
 
200 application/json

Create a new API Gateway Route

Create a new API Gateway Route

post

Path Parameters

gatewayIdstring(uuid)required

The UUID of your Gateway.

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

Body

application/json

The route to be created

APIGatewayRouteModify

namestringrequired

The name of the API Gateway Route.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the route.

pathstringrequired

The path to match for the route.

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

default_serviceAny Of
APIGatewayServiceReferenceByIdobject

A reference to an existing service by ID.

Show Child Parameters

Response

application/json

The created route.

APIGatewayRoute

namestringrequired

The name of the API Gateway Route.

>= 1 characters<= 255 characters

descriptionstring

A human-readable description of the route.

pathstringrequired

The path to match for the route.

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

idstring(uuid)required

The ID of the service.

default_serviceobject

A reference to an existing service by ID.

Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

post/api-gateways/{gatewayId}/routes

Body

{ "name": "name", "path": "path" }
 
application/json