List all Keys
List all Keys
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
The ID of your runtime group. 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
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
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.
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
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
The name to associate with the given keys.
Example:my-key
A unique identifier for a key.
Example:42
A JSON Web Key represented as a string.
Example:{\alg\:\RSA\, \kid\: \42\, ...}
A keypair in PEM format.
Show Child Parameters
An optional set of strings associated with the Key for grouping and filtering.
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.
Example:1422386534
The unique identifier or the prefix of the Vault to delete.
Example:24D0DBDA-671C-11ED-BA0B-EF1DCCD3725F
A JSON Web Key represented as a string.
Example:{\alg\:\RSA\, \kid\: \42\, ...}
A unique identifier for a key.
Example:42
Unix epoch when the resouce was updated.
Example:1422386534
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
An optional set of strings associated with the Key for grouping and filtering.
Authentication
Path Parameters
Body
Delete a Key
Delete a Key
Path Parameters
The unique identifier or the name of the Key to retrieve.
Example:24D0DBDA-671C-11ED-BA0B-EF1DCCD3725
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
204
Response
Successfully deleted Key or the resource didn’t exist
Authentication
Path Parameters
Get a Key
Get a Key using ID or name.
Query Parameters
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
Number of resources to be returned.
Default:100
>= 1<= 1000
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
The unique identifier or the name of the Key to retrieve.
Example:24D0DBDA-671C-11ED-BA0B-EF1DCCD3725
The ID of your runtime group. 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.
Example:1422386534
The unique identifier or the prefix of the Vault to delete.
Example:24D0DBDA-671C-11ED-BA0B-EF1DCCD3725F
A JSON Web Key represented as a string.
Example:{\alg\:\RSA\, \kid\: \42\, ...}
A unique identifier for a key.
Example:42
Unix epoch when the resouce was updated.
Example:1422386534
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
An optional set of strings associated with the Key for grouping and filtering.
Authentication
Path Parameters
Query Parameters
Upsert a Key
Create or Update Key using ID or name.
Path Parameters
The unique identifier or the name of the Key to retrieve.
Example:24D0DBDA-671C-11ED-BA0B-EF1DCCD3725
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
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
The name to associate with the given keys.
Example:my-key
A unique identifier for a key.
Example:42
A JSON Web Key represented as a string.
Example:{\alg\:\RSA\, \kid\: \42\, ...}
A keypair in PEM format.
Show Child Parameters
An optional set of strings associated with the Key for grouping and filtering.
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.
Example:1422386534
The unique identifier or the prefix of the Vault to delete.
Example:24D0DBDA-671C-11ED-BA0B-EF1DCCD3725F
A JSON Web Key represented as a string.
Example:{\alg\:\RSA\, \kid\: \42\, ...}
A unique identifier for a key.
Example:42
Unix epoch when the resouce was updated.
Example:1422386534
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
An optional set of strings associated with the Key for grouping and filtering.