Get Api Keys

Get the current tenant’s API keys

GET /api/v1/api-key

Error

A valid request URL is required to generate request examples

200

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "short_key": "<string>",
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "read_only": false,
    "last_used_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "workspace_names": [
      "<string>"
    ],
    "default_workspace_name": "<string>",
    "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "org_role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Response

200 - application/json

Successful Response

id · string<uuid> · required

short_key · string · required

description · string · required

created_at · string<date-time> | null

read_only · boolean · default: false · deprecated

last_used_at · string<date-time> | null

expires_at · string<date-time> | null

workspace_names · string[] | null

default_workspace_name · string | null

role_id · string<uuid> | null

org_role_id · string<uuid> | null

access_scope · enum<string> | null

Available options: organization, workspace