Skip to main content

POST /api-keys//regenerate

This endpoint regenerates an API key. This creates a new key value while keeping all metadata (name, description, permissions). The old key is immediately invalidated.
The new API key value is only shown once. The old key will stop working immediately.
You cannot regenerate the API key that is currently being used to make the request.

Path Parameters

string
required
The ID of the API key to regenerate.

Response

boolean
Whether the regeneration was successful.
string
A status message.
object
The regenerated API key details.
string
A reminder that the old key is now invalid.