Skip to main content
POST
@firma-dev/sdk

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

Pending keys expired successfully

API key expiration result

success
boolean
required

Whether the operation succeeded

workspace_id
string<uuid>
required
expired_keys
object[]

List of expired keys with details

message
string

Optional message when no pending keys exist