keys

Activate a client-generated access key

post/v1/keys

Request

  • Base URL: https://api.typenode.ai
  • URL: https://api.typenode.ai/v1/keys
  • Auth: HTTP bearer

Headers

Idempotency-Keystring uuid required

A caller-generated UUID identifying this exact semantic command.

Request body

capabilitiesstring[] required
environment_idsstring[]
expires_atstring date-time nullable
namestring required
secret_digeststring required
token_prefixstring required

Response

The admitted key-activation operation. The client retains the only raw key material.

completed_atstring date-time nullable required
created_atstring date-time required
kind'trigger.control' | 'trigger.delete' | 'workflow.delete' | 'workflow.deploy' | 'workflow.unpublish' | 'credential.activate' | 'credential.revoke' required
operation_idstring uuid required
outcome_code'succeeded' | 'hold_expired' | 'cancelled_by_administrator' | 'superseded_by_workflow_delete' | 'superseded_by_credential_revoke' | 'proof_failed' | 'operation_failed' nullable required
proof_expires_atstring date-time nullable required
retry_afterstring date-time nullable required
state'held' | 'queued' | 'in_progress' | 'succeeded' | 'failed' | 'cancelled' required
status_urlstring required
terminalboolean required
updated_atstring date-time required

Changes

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