Sign in
latestOpenAPI 3.1.02026-08-22154287463.4 KB

858365328f92

API Keys

Update an API key

Update an API key's name.

patch/org/api_keys/{id}

Path parameters

idstring required

API key ID

Request body

namestring required

New API key name

Example request

{
  "name": "new-api-name"
}

Response

API key updated

created_atstring date-time required

When the API key was created

deleted_atstring date-time nullable required

When the API key was deleted (soft-deleted). Null for keys that have not been deleted.

expires_atstring date-time nullable required

When the API key expires

idstring required

Unique API key identifier

masked_keystring required

Masked version of the API key

namestring required

Label for the API key. API keys are not addressable by name; use the ID or key identifier for stable references.

project_idstring nullable required

Project identifier for project-scoped API keys. Null means org-wide.

project_namestring nullable required

Project name for project-scoped API keys. Null means the key is org-wide or the project name is unavailable.

Example response

{
  "created_by": {
    "email": "user@example.com",
    "id": "user-abc123",
    "name": "Jane Doe"
  },
  "id": "ckv9w8q2f000001l5r3j7k9m4",
  "masked_key": "sk_1234...abcd",
  "name": "production",
  "project_id": "proj_abc123",
  "project_name": "Production"
}