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

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

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/keys
 
application/json

Create a new Key

Create a new Key

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 Key for creation

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.

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

jwkstring

A JSON Web Key represented as a string.

kidstringrequired

A unique identifier for a key.

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
namestring

The name to associate with the given keys.

pemobject

A keypair in PEM format.

Show Child Parameters
setobject

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

Show Child Parameters
tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

x5tstring

X.509 certificate SHA-1 thumbprint.

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.

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

jwkstring

A JSON Web Key represented as a string.

kidstringrequired

A unique identifier for a key.

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
namestring

The name to associate with the given keys.

pemobject

A keypair in PEM format.

Show Child Parameters
setobject

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

Show Child Parameters
tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

x5tstring

X.509 certificate SHA-1 thumbprint.

post/control-planes/{controlPlaneId}/core-entities/keys

Body

{ "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" } }
 
application/json

Get a Key

Get a Key using ID or name.

get

Path Parameters

KeyIdstringrequired

ID of the Key to lookup

Example:bba22c06-a632-42be-a018-1b9ff357b5b9

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

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

jwkstring

A JSON Web Key represented as a string.

kidstringrequired

A unique identifier for a key.

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
namestring

The name to associate with the given keys.

pemobject

A keypair in PEM format.

Show Child Parameters
setobject

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

Show Child Parameters
tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

x5tstring

X.509 certificate SHA-1 thumbprint.

get/control-planes/{controlPlaneId}/core-entities/keys/{KeyId}
 
application/json

Upsert a Key

Create or Update Key using ID or name.

put

Path Parameters

KeyIdstringrequired

ID of the Key to lookup

Example:bba22c06-a632-42be-a018-1b9ff357b5b9

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

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

jwkstring

A JSON Web Key represented as a string.

kidstringrequired

A unique identifier for a key.

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
namestring

The name to associate with the given keys.

pemobject

A keypair in PEM format.

Show Child Parameters
setobject

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

Show Child Parameters
tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

x5tstring

X.509 certificate SHA-1 thumbprint.

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.

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

idstring

A string representing a UUID (universally unique identifier).

jwkstring

A JSON Web Key represented as a string.

kidstringrequired

A unique identifier for a key.

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
namestring

The name to associate with the given keys.

pemobject

A keypair in PEM format.

Show Child Parameters
setobject

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

Show Child Parameters
tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

x5tstring

X.509 certificate SHA-1 thumbprint.

put/control-planes/{controlPlaneId}/core-entities/keys/{KeyId}

Body

{ "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" } }
 
application/json

MTLS-auth credentials