Retrieves an API key

Retrieves a specific API key by its UUID. Returns key metadata including name, kind, expiration, last usage timestamp, and the grace period status — the secret token is never included.

GET /v1/api_keys/{id}

Retrieves an API key

cURL

curl --request GET \
  --url https://api.rootly.com/v1/api_keys/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "id": "<string>",
    "attributes": {
      "name": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "description": "<string>",
      "role_id": "<string>",
      "on_call_role_id": "<string>",
      "expires_at": "<string>",
      "last_used_at": "<string>",
      "grace_period_ends_at": "<string>"
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string<uuid> · required

Resource UUID

Query Parameters

include · string

Comma-separated list of relationships to include (role, on_call_role, created_by, groups)

Response

200

application/vnd.api+json

API key found

data · object · required

Show child attributes