API keys

Create an API key

Create an API key scoped to the capabilities you choose. The response includes the plaintext key exactly once — store it securely now, because it can never be retrieved again (only revoked). This endpoint is session-gated: it requires a dashboard session and cannot be called with a Bearer API key.

post/api-keys

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/api-keys
  • Auth: HTTP bearer

Request body

namestring required
scope'full' | 'sending' | 'read_only'
capabilitiesstring[]

Response

Created — includes the one-time plaintext key.

object'api_key' required
idstring required
namestring required
prefixstring required
scope'full' | 'sending' | 'read_only' required
capabilitiesstring[] required
last_used_atstring nullable required
revoked_atstring nullable required
created_atstring required
keystring required

The plaintext secret. Shown exactly once — store it now; it can never be retrieved again.

Changes

No recorded changes to this operation across all 1 revision of this API.