Sign in

v1

latestOpenAPI 3.1.02026-07-263580186.3 KB
API Keys

Update API key

Update an existing API key.

Supports renaming and replacing the workspace scope:

  • Pass scopes with a non-empty list of {workspace_id, permission} entries to replace the full scope set. Existing scope rows not in the new list are dropped.
  • Pass scopes: [] to unscope the key entirely.
  • The permission ceiling on each scoped workspace is re-validated against your current role there.
patch/api/v3/keys/{id}

Path parameters

idstring required

Request body

namestring

Response

The updated API key.

idstring required
namestring required
prefixstring required
created_atstring date-time required
expires_atstring date-time nullable required