Workspaces

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

Request

Base URL
https://api.firma.dev/functions/v1/signing-request-api
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/firma/apis/firma-partner-api/docs/workspaces/:id/api-key/expire/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

Workspace ID

Request body

key_type'live' | 'test'

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

Response

Pending keys expired successfully

successboolean required

Whether the operation succeeded

workspace_idstring uuid required

messagestring

Optional message when no pending keys exist

Changes

No recorded changes to this operation across all 13 revisions of this API.