Delete a KeySet
Delete a KeySet
Path Parameters
ID of the KeySet to lookup
Example:6cc34248-50b4-4a81-9201-3bdf7a83f712
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Successfully deleted KeySet or the resource didn’t exist
Authentication
Path Parameters
Get a KeySet
Get a KeySet using ID or name.
Path Parameters
ID of the KeySet to lookup
Example:6cc34248-50b4-4a81-9201-3bdf7a83f712
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
Successfully fetched KeySet
KeySet
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
The name to associate with the given key-set.
A string representing a tag.
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Upsert a KeySet
Create or Update KeySet using ID or name.
Path Parameters
ID of the KeySet to lookup
Example:6cc34248-50b4-4a81-9201-3bdf7a83f712
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Description of the KeySet
KeySet
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
The name to associate with the given key-set.
A string representing a tag.
Unix epoch when the resource was last updated.
Response
application/json
Response
Successfully upserted KeySet
KeySet
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
The name to associate with the given key-set.
A string representing a tag.
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Body
Keys
A key object holds a representation of asymmetric keys in various formats. When Kong Gateway or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.
List all Keys associated with a KeySet
List all Keys associated with a KeySet
Query Parameters
Number of resources to be returned.
Default:100
>= 1<= 1000
Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources
A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.
Example:tag1,tag2
Path Parameters
ID of the KeySet to lookup
Example:6cc34248-50b4-4a81-9201-3bdf7a83f712
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
200 application/json
Response
A successful response listing Keys
A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.
Example:{"id":"d958f66b-8e99-44d2-b0b4-edd5bbf24658","jwk":"{\"alg\":\"RSA\", \"kid\": \"42\", ...}","kid":"42","name":"a-key","pem":{"private_key":"-----BEGIN","public_key":"-----BEGIN"},"set":{"id":"b86b331c-dcd0-4b3e-97ce-47c5a9543031"}}
Show Child Parameters
URI to the next page (may be null)
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page