API Keys
Rotate API Key
Rotate an API key, generating new key material while preserving name and permissions
POST
Overview
Rotates an existing API key by generating new key material. The old key is immediately invalidated and a new plaintext key is returned. The key’s name and permissions are preserved. Auth: Requires JWT (dashboard operation only). Important: The new plaintext key is shown only once in this response. Store it securely.Path Parameters
string
required
The API key UUID to rotate
Response
string
API key UUID (unchanged)
string
New plaintext API key (shown once only — store it securely)
string
First 8 characters of the new key (for identification)
string
Key name (preserved from original)
string
Original creation timestamp
string
Last usage timestamp (reset on rotation)
object
Resource permissions (preserved from original).
null means unrestricted.