API Keys

Create API key

Generate a new API key. The full key value is returned only once in the response. Store it securely.

post/v1/api-keys

Request

Base URL: https://smtpfa.st/api
URL: https://smtpfa.st/api/v1/api-keys
Auth: HTTP bearer

Request body

namestring required

A human-readable name for the key

scopesstring[]

Optional list of scopes to restrict the key. Available: email:send, email:read, domain:read, domain:write, contact:read, contact:write, form:read, form:write, webhook:read, webhook:write, logs:read, inbound:read, inbound:delete, team:read, team:manage, apikey:manage. If omitted the key gets the default set: everything except logs:read, inbound:read, inbound:delete, team:read, team:manage and apikey:manage. Listing, creating or revoking keys through the API requires apikey:manage.

Example request

{
  "name": "Production",
  "scopes": [
    "email:send",
    "domain:read"
  ]
}

Response

API key created (includes the full key value)

idstring

namestring

keystring

prefixstring

scopesstring[]

created_atstring date-time

Example response

{
  "id": "key_abc123",
  "name": "Production",
  "key": "sf_live_abc123def456...",
  "prefix": "sf_live_a",
  "scopes": [
    "emails:send",
    "domains:read"
  ],
  "created_at": "2026-04-05T12:00:00Z"
}

Changes

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