Expire pending API keys

Immediately expires all pending API keys (those with expires_at set) for a workspace. Useful after verifying that the new key works correctly. Cannot be used on protected workspaces. Rate limited to 1 request per minute.

POST /workspaces/{id}/api-key/expire

Expire pending API keys

cURL

curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspaces/{id}/api-key/expire \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "success": true,
  "expired_keys": [
    {
      "id": "old-key-uuid",
      "api_key": "firma_old456...",
      "original_expires_at": "2024-12-18T10:30:00Z",
      "expired_at": "2024-12-17T10:30:00Z"
    }
  ],
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
}

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

Body

application/json

key_type · enum<string>

Optionally restrict expiry to one key type ('live' or 'test'). If omitted, all pending keys are expired (current behavior).

Available options: live, test

Response

200

application/json

Pending keys expired successfully

success · boolean

Whether the operation succeeded

expired_keys · object[]

List of expired keys with details

Show child attributes

workspace_id · string<uuid>

message · string

Optional message when no pending keys exist