Skip to main content
PATCH
/
workspace
/
api-key
Regenerate API Key
curl --request PATCH \
  --url https://prod-api.ringg.ai/ca/api/v0/workspace/api-key \
  --header 'X-API-KEY: <x-api-key>'
{
  "new_api_key": "e89b12d3-a456-426c-8001-f05de02b54b4"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ringg.ai/llms.txt

Use this file to discover all available pages before exploring further.

Regenerate the current workspace API key. This immediately invalidates the previous key.

​
Before calling

  • Coordinate a deployment that updates every backend service using the old key.
  • Confirm that no client-side code depends on the workspace key.
  • Make sure the caller has permission to manage API keys.

​
Rollout pattern

  1. Regenerate the key from a secure admin backend or the dashboard.
  2. Store the new key in your secret manager.
  3. Redeploy services that call Ringg APIs.
  4. Verify with GET /workspace.
Do not regenerate the key from a browser-only integration. API keys are workspace secrets.

Headers

​
X-API-KEY
string
required

(Required) Your current Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Response

Successful Response: New API key generated.

​
new_api_key
string
Example:

"e89b12d3-a456-426c-8001-f05de02b54b4"