Skip to main content
POST
Rotate an API key
Requires an authenticated dashboard session. Returns 201 Created.
uuid
required
Workspace that owns the current key.
uuid
required
Key metadata identifier to replace.
integer
default:"86400"
required
Time the old key may remain valid while consumers roll over. Minimum 0; maximum 604,800 seconds (seven days).

Response

string
required
Replacement plaintext ig_live_ secret. Returned only once.
uuid | null
required
ID of the key this credential replaces.
string | null
required
Timestamp after which the old key is no longer valid.
1

Store the replacement

Write the one-time secret to your server-side secret manager.
2

Deploy consumers

Update every service before the grace window closes.
3

Verify and revoke

Confirm the new prefix is in use, then revoke the old key early when safe.
Last modified on August 16, 2026