API Keys

Update API key

Renames an API key. The token itself is immutable — use create + revoke if you need a new value.

patch/v1/api-keys/{apiKeyId}

Request

apiKeyIdstring required

API-key identifier.

namestring required

New human-readable name for the API key.

API key updated

idstring required

Stable API-key identifier.

organizationIdstring required

Organization that owns this API key.

scope'organization' | 'project' required

organization keys can call every route. project keys are bound to projectId.

projectIdstring nullable required

Project this key is bound to. null for an organization-wide key.

projectSlugstring nullable required

Slug of the bound project, when the project still exists. null for organization-wide keys.

namestring required

Human-readable name.

tokenstring required

The full API key token. Returned by create / get / update — store it securely; treat it as a password.

lastUsedAtstring nullable required

ISO-8601 timestamp of the most recent successful authentication. null until first use.

deletedAtstring nullable required

ISO-8601 timestamp at which the key was revoked. null while the key is active.

createdAtstring required

ISO-8601 timestamp of creation.

updatedAtstring required

ISO-8601 timestamp of the last metadata update (rename, revoke, last-used touch).