Update a service shared policy chain policy
Update a service shared policy chain outbound policy
Path Parameters
The ID of the API Gateway Shared Policy Chain.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the API Gateway Policy.
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 a service shared policy chain policy
Delete a service shared policy chain outbound policy
Path Parameters
The ID of the API Gateway Shared Policy Chain.
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the API Gateway Policy.
Response
Response
Success
Authentication
Path Parameters
List API Gateway DataPlane Certificates
Returns a list of dataplane certificates that are associated to this API gateway. A dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this 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 certificates associated with an API Gateway.
Pagination metadata.
Show Child Parameters
A dataplane certificate.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create a New DataPlane Certificate
Create new dataplane certificate to this API gateway. A dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this API gateway.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Request body for creating a certificate.
JSON escaped string of the certificate.
The name to identify the certificate.
A description of the certificate.
Response
application/json
Response
Created
APIGatewayDataPlaneCertificate
A dataplane certificate.
The unique identifier of the certificate.
JSON escaped string of the certificate.
The name to identify of the certificate.
>= 1 characters<= 255 characters
A description of the certificate.
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
Metadata extracted from a certificate.
Show Child Parameters
Authentication
Path Parameters
Body
Get DataPlane Certificate
Returns information about an individual dataplane certificate.
Path Parameters
The UUID of your Gateway.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The ID of the dataplane certificate.
Response
application/json
Response
A single dataplane certificate.
APIGatewayDataPlaneCertificate
A dataplane certificate.
The unique identifier of the certificate.
JSON escaped string of the certificate.
The name to identify of the certificate.
>= 1 characters<= 255 characters
A description of the certificate.
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
Metadata extracted from a certificate.