API keys

Update an API key

Updates name, expiresAt, and/or access; omitted fields are left unchanged, and sending none returns the current metadata. Providing access replaces the entire access configuration atomically — previous grants are removed and the change applies to the next request that uses the key; any website id belonging to another organization fails with 400. On a revoked or already-expired key, setting expiresAt (including null to remove expiry) or access fails with 409, because inactive keys cannot be made active again; renames still succeed.

patch/apiKeys/{apiKeyId}

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/apiKeys/{apiKeyId}
  • Auth: HTTP bearer

Path parameters

apiKeyIdstring required

Request body

namestring

Response

The updated key metadata.

idstring required

Unique id of the API key.

namestring required

Human-readable label, 1–200 characters.

organizationIdstring required

Id of the organization that owns the key.

expiresAtstring date-time nullable required

When the key stops authenticating. null when it never expires.

revokedAtstring date-time nullable required

When the key was revoked. null while the key is active.

createdAtstring date-time required

When the key was created.

Changes

No recorded changes to this operation across all 1 revision of this API.