Key-sets
Key-sets
List all Key-sets
Retrieve a list of all Key-sets in the system. A Key Set object holds a collection of asymmetric key objects. This entity allows to logically group keys by their purpose. Key Sets can be both tagged and filtered by tags.
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
Key set object response body
Example:4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F
The name to associate with the given key-set.
Example:my-key_set
Unix epoch when the resource was last created.
Example:1422386534
Unix epoch when the resource was last updated.
Example:1422386534
The name to associate with the given key-set.
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Example:http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969
Authentication
Path Parameters
Query Parameters
Create a new Key-set
This endpoint allows creating a new Key-set by sending a JSON object that describes the Key-set to be created.The request body must contain all the fields required to create a new Key-set.
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 name to associate with the given key-set.
Example:my-key_set
An optional set of strings associated with the Key for grouping and filtering.
Response
application/json
Response
Key set object response body
Example:4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F
The name to associate with the given key-set.
Example:my-key_set
Unix epoch when the resource was last created.
Example:1422386534
Unix epoch when the resource was last updated.
Example:1422386534
The name to associate with the given key-set.
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Example:http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969
Authentication
Path Parameters
Body
Delete a Key-set
Delete a Key-set.
Path Parameters
The unique identifier or the name attribute of the Key Set that should be associated to the newly-created Key.
Example:46CA83EE-671C-11ED-BFAB-2FE47512C77A
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-set or the resource didn’t exist
Authentication
Path Parameters
Get a Key-set
This endpoint retrieves information about a specific key-set based on its 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 attribute of the Key Set that should be associated to the newly-created Key.
Example:46CA83EE-671C-11ED-BFAB-2FE47512C77A
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
Key set object response body
Example:4D0DBDA-671C-11ED-BA0B-EF1DCCD3725F
The name to associate with the given key-set.
Example:my-key_set
Unix epoch when the resource was last created.
Example:1422386534
Unix epoch when the resource was last updated.
Example:1422386534
The name to associate with the given key-set.
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Example:http://localhost:8001/key-sets?offset=6378122c-a0a1-438d-a5c6-efabae9fb969