Create a new KeySet

Create a new KeySet

post

Path Parameters

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 new KeySet for creation

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 created 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.

post/control-planes/{controlPlaneId}/core-entities/key-sets

Body

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

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.