GET /keys/{uuid}/

Get a single API key.

GET /keys/{uuid}/ — uuid

The first eight characters of the key's UUID.

GET /api/v2/keys/{uuid}/

Get a single API key.

Try it out

Playground

Authorization

api-key

Variables

Key

Value

uuid*

Authorizations

Authorizations

api-key

Type

API Key (header: Authorization)

or

ripe-access

Type

API Key (cookie: crowd.token_key)

Parameters

Path Parameters

uuid*

The first eight characters of the key's UUID.

Type

string

Required

Responses

Responses

Content-Type

application/json

object

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

Defaulttrue

Whether 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)

object[]

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

object

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