API-keys
List all API-keys associated with a Consumer
List all API-keys associated with a Consumer
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
Consumer ID for nested entities
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 API-keys
Example:{"consumer":{"id":"84a73fb8-50fc-44a7-a4d5-aa17728ee83f"},"id":"b2f34145-0343-41a4-9602-4c69dec2f269","key":"IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"}
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 API-key associated with a Consumer
Create a new API-key associated with a Consumer
Path Parameters
Consumer ID for nested entities
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 API-key for creation
KeyAuthWithoutParents
Show Child Parameters
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
A string representing a tag.
key-auth ttl in seconds
Response
201 application/json
Response
Successfully created API-key
KeyAuth
Show Child Parameters
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
A string representing a tag.
key-auth ttl in seconds
Authentication
Path Parameters
Body
Delete a an API-key associated with a Consumer
Delete a an API-key associated with a Consumer using ID.
Path Parameters
Consumer ID for nested entities
ID of the API-key to lookup
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
204
Response
Successfully deleted API-key or the resource didn’t exist
Authentication
Path Parameters
Get an API-key associated with a Consumer
Get an API-key associated with a Consumer using ID.
Path Parameters
Consumer ID for nested entities
ID of the API-key to lookup
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 API-key
KeyAuth
Show Child Parameters
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
A string representing a tag.
key-auth ttl in seconds