Delete a KeySet

Delete a KeySet

delete

Path Parameters

KeySetIdstringrequired

ID of the KeySet to lookup

Example:6cc34248-50b4-4a81-9201-3bdf7a83f712

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

Successfully deleted KeySet or the resource didn’t exist

delete/control-planes/{controlPlaneId}/core-entities/key-sets/{KeySetId}
 

Get a KeySet

Get a KeySet using ID or name.

get

Path Parameters

KeySetIdstringrequired

ID of the KeySet to lookup

Example:6cc34248-50b4-4a81-9201-3bdf7a83f712

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

application/json

Successfully fetched KeySet

KeySet

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

namestring

The name to associate with the given key-set.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

get/control-planes/{controlPlaneId}/core-entities/key-sets/{KeySetId}
 
application/json

Upsert a KeySet

Create or Update KeySet using ID or name.

put

Path Parameters

KeySetIdstringrequired

ID of the KeySet to lookup

Example:6cc34248-50b4-4a81-9201-3bdf7a83f712

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Body

application/json

Description of the KeySet

KeySet

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

namestring

The name to associate with the given key-set.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

Response

application/json

Successfully upserted KeySet

KeySet

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

idstring

A string representing a UUID (universally unique identifier).

namestring

The name to associate with the given key-set.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

put/control-planes/{controlPlaneId}/core-entities/key-sets/{KeySetId}

Body

{ "id": "b58c7d9d-e54f-444c-b24d-cdfc4159f61e", "name": "example-key-set", "tags": [ "idp-keys" ] }
 
application/json

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

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

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

tagsstring

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

KeySetIdstringrequired

ID of the KeySet to lookup

Example:6cc34248-50b4-4a81-9201-3bdf7a83f712

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

200 application/json

A successful response listing Keys

dataarray[object]

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

* Additional properties are NOT allowed.
Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/control-planes/{controlPlaneId}/core-entities/key-sets/{KeySetId}/keys
 
200 application/json