Tenancy

Rotate the workspace default key (new secret returned once)

Mints a new default key and revokes the old active one in one transaction: the old key stops authenticating at once, and there is never a moment with two active default keys or none. The workspace's other keys are untouched. With no active default key it simply creates one. Same provision secret guard as POST /tenants/{tenant_id}/default-key.

post/tenants/{tenant_id}/default-key:rotate

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/tenants/{tenant_id}/default-key:rotate
  • Auth: API key in header X-Provision-Secret

Path parameters

tenant_idstring required

Response

Rotated; api_key is the new full secret, shown once

key_idstring required
prefixstring required

The stored, non-secret prefix, for example cd_live_ab12cd34.

createdboolean required

true when this call minted the key; api_key is present only then.

api_keystring

The full secret, cd_live_… or cd_test_…; shown once.

Changes

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