Skip to main content
POST
/
workspaces
/
{id}
/
api-key
/
expire
Expire pending API keys
curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspaces/{id}/api-key/expire \
  --header 'Authorization: <api-key>'
{
  "message": "Expired 1 pending API key(s)",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "expired_count": 1,
  "expired_keys": [
    "old-key-uuid"
  ]
}

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

Pending keys expired successfully

​
message
string
​
workspace_id
string<uuid>
​
expired_count
integer

Number of keys that were expired

​
expired_keys
string<uuid>[]

List of expired key IDs