Keys

Keys

List all Keys

List all Keys

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

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

Show Child Parameters
offsetstring

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

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

Create a new Key

This API endpoint allows you to create a new key. When the request is successful, the API will respond with a 200 status code and a JSON object that represents the newly created key. If the request is invalid, the API will respond with a 400 status code and an error message in the response body.

post

Path Parameters

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

post/runtime-groups/{runtimeGroupId}/core-entities/keys

Body

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

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