Get a Key in a workspace
Get a Key using ID or name in a workspace.
Path Parameters
The name of the workspace
Example:team-payments
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
A JSON Web Key represented as a string.
A unique identifier for a key.
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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 in a workspace
Create or Update Key using ID or name in a workspace.
Path Parameters
The name of the workspace
Example:team-payments
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
A JSON Web Key represented as a string.
A unique identifier for a key.
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
A JSON Web Key represented as a string.
A unique identifier for a key.
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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
List all Keys associated with a KeySet
List all Keys associated with a KeySet
Query Parameters
Number of resources to be returned.
Default:100
>= 1<= 1000
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
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
ID of the KeySet to lookup
Example:6cc34248-50b4-4a81-9201-3bdf7a83f712
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
200 application/json
Response
A successful response listing Keys
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
URI to the next page (may be null)
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Authentication
Path Parameters
Query Parameters
Create a new Key associated with a KeySet
Create a new Key associated with a KeySet
Path Parameters
ID of the KeySet to lookup
Example:6cc34248-50b4-4a81-9201-3bdf7a83f712
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 new Key for creation
KeyWithoutParents
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
A JSON Web Key represented as a string.
A unique identifier for a key.
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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
201 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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
A JSON Web Key represented as a string.
A unique identifier for a key.
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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
Get a Key associated with a KeySet
Get a Key associated with a KeySet using ID or name.
Path Parameters
ID of the KeySet to lookup
Example:6cc34248-50b4-4a81-9201-3bdf7a83f712
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.
User-defined entity description. Konnect only field, not synced to the Gateway.
A string representing a UUID (universally unique identifier).
A JSON Web Key represented as a string.
A unique identifier for a key.
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
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.