Create a new Key
Create a new Key
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
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.
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
A JSON Web Key represented as a string.
A unique identifier for a key.
The name to associate with the given keys.
A keypair in PEM format.
Show Child Parameters
The id (an UUID) of the key-set with which to associate the key.
Show Child Parameters
A string representing a tag.
Unix epoch when the resource was last updated.
X.509 certificate SHA-1 thumbprint.
Response
application/json
Response
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.
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
A JSON Web Key represented as a string.
A unique identifier for a key.
The name to associate with the given keys.
A keypair in PEM format.
Show Child Parameters
The id (an UUID) of the key-set with which to associate the key.
Show Child Parameters
A string representing a tag.
Unix epoch when the resource was last updated.
X.509 certificate SHA-1 thumbprint.
Authentication
Path Parameters
Body
Delete a Key
Delete a Key
Path Parameters
ID of the Key to lookup
Example:bba22c06-a632-42be-a018-1b9ff357b5b9
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Successfully deleted Key or the resource didn’t exist
Authentication
Path Parameters
Get a Key
Get a Key using ID or name.
Path Parameters
ID of the Key to lookup
Example:bba22c06-a632-42be-a018-1b9ff357b5b9
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
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.
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
A JSON Web Key represented as a string.
A unique identifier for a key.
The name to associate with the given keys.
A keypair in PEM format.
Show Child Parameters
The id (an UUID) of the key-set with which to associate the key.
Show Child Parameters
A string representing a tag.
Unix epoch when the resource was last updated.
X.509 certificate SHA-1 thumbprint.
Authentication
Path Parameters
Upsert a Key
Create or Update Key using ID or name.
Path Parameters
ID of the Key to lookup
Example:bba22c06-a632-42be-a018-1b9ff357b5b9
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
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.
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
A JSON Web Key represented as a string.
A unique identifier for a key.
The name to associate with the given keys.
A keypair in PEM format.
Show Child Parameters
The id (an UUID) of the key-set with which to associate the key.
Show Child Parameters
A string representing a tag.
Unix epoch when the resource was last updated.
X.509 certificate SHA-1 thumbprint.
Response
application/json
Response
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.
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
A JSON Web Key represented as a string.
A unique identifier for a key.
The name to associate with the given keys.
A keypair in PEM format.
Show Child Parameters
The id (an UUID) of the key-set with which to associate the key.
Show Child Parameters
A string representing a tag.
Unix epoch when the resource was last updated.
X.509 certificate SHA-1 thumbprint.