Skip to main content
POST
/
workspaces
/
{id}
/
api-key
/
regenerate
Regenerate workspace API key
curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspaces/{id}/api-key/regenerate \
  --header 'Authorization: <api-key>'
{
  "message": "API key regenerated. Old keys will expire in 24 hours.",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "new_key": "firma_api_abc123xyz...",
  "expiring_keys": [
    {
      "id": "old-key-uuid",
      "expires_at": "2024-12-18T10:30:00Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

​
id
string<uuid>
required

Workspace ID

Response

API key regenerated successfully

​
message
string
​
workspace_id
string<uuid>
​
new_key
string

The newly generated API key

​
expiring_keys
object[]

List of keys that were set to expire in 24 hours