Authorizations
api-key
Type
API Key (header: Authorization)
or
ripe-access
Type
API Key (cookie: crowd.token_key)
GET /keys/
Get a list of your API keys, with optional filtering and sorting.
GET /keys/ — page
A page number within the paginated result set.
GET /keys/ — page_size
Number of results to return per page.
GET /keys/ — permission
Filter for keys with grants of the given permission.
GET /keys/ — target_id
Filter for keys with grants of the given type-specific ID.
GET /keys/ — target_type
Filter for keys with grants for the given target type.
GET /api/v2/keys/
Get a list of your API keys, with optional filtering and sorting.
Try it out
Playground
Authorization
Variables
Key
Value
Authorizations
Parameters
Query Parameters
page
A page number within the paginated result set.
Type
integer
page_size
Number of results to return per page.
Type
integer
permission
Filter for keys with grants of the given permission.
Type
string
target_id
Filter for keys with grants of the given type-specific ID.
Type
string
target_type
Filter for keys with grants for the given target type.
Type
string
Responses
Responses
application/json
Format
"uri"Format
"uri"String to be provided when making authenticated requests to the API, masked in the keys API output after first creation/regeneration.
Format
"url"A human-readable identifier to help you organise and manage your keys
The time when this key was created or regenerated
Format
"date-time"The key will start to be usable at this time, or immediately if is omitted or null
Format
"date-time"The key will stop being usable at this time, or never if is omitted or null
Format
"date-time"The last time this key was used to authenticate with the API
Format
"date-time"Can be manually set to true or false to control whether this key is active, regardless of the valid_from and valid_to values
Default
trueWhether this key is currently enabled and within its defined usability time range
Whether this key is frozen after a long period of inactivity (unfreeze with a new secret using the regenerate flag)
Grants are the permissions that are granted by this key, possibly relating to specific objects such as measurements, probes or other API keys
Permission or action to allow with this grant
Which object (probe, measurement, etc) this grant refers to (required by some permissions, not allowed for the rest)
Type of target resource
Type-specific unique identifier for the target