Rotate an owned tenant API key (new plainTextKey once)

Authorization

provider-key

x-provider-key<token>

Provider control-plane key (reseller: manage owned tenants)

In: header

Path Parameters

id*string

Tenant CUID

keyId*string

API key CUID to rotate

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

gracePeriodSeconds?number

Overlap window in seconds. When set, the outgoing key keeps authenticating until now + this many seconds (via expiresAt) instead of being deactivated immediately — so a live integrator does not get 401s mid-deploy. Capped at 30 days. Omit for an immediate cutover.

Range1 <= value <= 2592000

expiresAt?string

Expiry for the NEW key. Omit for a non-expiring replacement — the outgoing key's own expiry is never inherited.

Response Body

curl -X POST "https://example.com/api/v1/provider/tenants/string/api-keys/string/rotate" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Rotate an owned tenant API key (new plainTextKey once)

Authorization

Path Parameters

Request Body

Response Body

200

404