Create org tracing key

POST /api/v1/orgs/current/tracing-keys

Error

A valid request URL is required to generate request examples

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "short_key": "<string>",
  "description": "<string>",
  "key": "<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",
  "revoked_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",
  "access_scope": "organization",
  "created_by": "<string>",
  "is_tracing_key": false,
  "workspace_ids": [],
  "can_delete": false
}

Authorizations

API KeyOrganization IDBearer Auth

X-API-Key · string · header · required

Body

application/json

workspaces · string<uuid>[] · required

Minimum array length: 1

description · string · default: Tracing key

expires_at · string<date-time> | null

Response

201

application/json

Successful Response

API key POST schema.

id · string<uuid> · required

short_key · string · required

description · string · required

key · 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

revoked_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

created_by · string | null

is_tracing_key · boolean · default: false

workspace_ids · string<uuid>[]

can_delete · boolean · default: false

Whether tracing-key deletion authority has been confirmed. Legacy key responses do not evaluate this capability.