Workspaces

Regenerate workspace API key

Regenerates the API key for a workspace. Sets 24-hour expiration on existing active keys and creates a new key. Cannot be used on protected workspaces. Rate limited to 1 request per minute.

post/workspaces/{id}/api-key/regenerate

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/regenerate/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'

Which key type to regenerate ('live' or 'test'). Defaults to 'live'. Regenerating one type does not expire or affect the other.

Response

API key regenerated successfully

key_type'live' | 'test' required

The key type that was regenerated

workspace_idstring uuid required

Changes

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