Delete a Key

Delete a Key

delete

Path Parameters

key_id_or_namestringrequired

The unique identifier or the name of the Key to retrieve.

Example:24D0DBDA-671C-11ED-BA0B-EF1DCCD3725

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Response

204

Successfully deleted Key or the resource didn’t exist

delete/runtime-groups/{runtimeGroupId}/core-entities/keys/{key_id_or_name}
 
204

Get a Key

Get a Key using ID or name.

get

Query Parameters

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

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

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

key_id_or_namestringrequired

The unique identifier or the name of the Key to retrieve.

Example:24D0DBDA-671C-11ED-BA0B-EF1DCCD3725

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Response

application/json

Successfully fetched Key

Key

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.

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

idstring

The unique identifier or the prefix of the Vault to delete.

Example:24D0DBDA-671C-11ED-BA0B-EF1DCCD3725F

jwkstring

A JSON Web Key represented as a string.

Example:{\alg\:\RSA\, \kid\: \42\, ...}

kidstring

A unique identifier for a key.

Example:42

updated_atinteger

Unix epoch when the resouce was updated.

Example:1422386534

pemobject

A keypair in PEM format.

Show Child Parameters
setobject

The id (an UUID) of the key-set with which to associate the key.

* Additional properties are NOT allowed.
Show Child Parameters
tagsarray[string]

An optional set of strings associated with the Key for grouping and filtering.

get/runtime-groups/{runtimeGroupId}/core-entities/keys/{key_id_or_name}
 
application/json

Upsert a Key

Create or Update Key using ID or name.

put

Path Parameters

key_id_or_namestringrequired

The unique identifier or the name of the Key to retrieve.

Example:24D0DBDA-671C-11ED-BA0B-EF1DCCD3725

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Body

application/json
setobject

The id (an UUID) of the key-set with which to associate the key .With form-encoded, the notation is set.id=<set id> or set.name=<set name>. With JSON, use “set:{id:<set id>} or set:{name:<set name>}.

Show Child Parameters
namestring

The name to associate with the given keys.

Example:my-key

kidstringrequired

A unique identifier for a key.

Example:42

jwkstring

A JSON Web Key represented as a string.

Example:{\alg\:\RSA\, \kid\: \42\, ...}

pemobject

A keypair in PEM format.

Show Child Parameters
tagsarray[string]

An optional set of strings associated with the Key for grouping and filtering.

Response

application/json

Successfully upserted Key

Key

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.

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

idstring

The unique identifier or the prefix of the Vault to delete.

Example:24D0DBDA-671C-11ED-BA0B-EF1DCCD3725F

jwkstring

A JSON Web Key represented as a string.

Example:{\alg\:\RSA\, \kid\: \42\, ...}

kidstring

A unique identifier for a key.

Example:42

updated_atinteger

Unix epoch when the resouce was updated.

Example:1422386534

pemobject

A keypair in PEM format.

Show Child Parameters
setobject

The id (an UUID) of the key-set with which to associate the key.

* Additional properties are NOT allowed.
Show Child Parameters
tagsarray[string]

An optional set of strings associated with the Key for grouping and filtering.

put/runtime-groups/{runtimeGroupId}/core-entities/keys/{key_id_or_name}

Body

{ "kid": "42" }
 
application/json

Key-sets

Key-sets

List all Key-sets

Retrieve a list of all Key-sets in the system. A Key Set object holds a collection of asymmetric key objects. This entity allows to logically group keys by their purpose. Key Sets can be both tagged and filtered by tags.

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

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

Response

200 application/json

Key set object response body

idstring

Example:4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F

namestring

The name to associate with the given key-set.

Example:my-key_set

created_atinteger

Unix epoch when the resource was last created.

Example:1422386534

updated_atinteger

Unix epoch when the resource was last updated.

Example:1422386534

tagsarray[string]

The name to associate with the given key-set.

nextstring

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

Example:http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969

get/runtime-groups/{runtimeGroupId}/core-entities/key-sets
 
200 application/json