Skip to main content
POST
Create pod API key

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Pod ID or your own clientId

Body

application/json
name
string | null

Human-readable label to identify the key later.

Maximum string length: 255

Response

API key created

API key created

id
string

OpenMail API key ID

name
string | null

Human-readable label for the key, if set.

podId
string | null

ID of the pod this key is scoped to. A key can only access resources in this pod.

tokenPrefix
string

Non-secret leading characters of the token, to help you identify it.

last4
string

Last 4 characters of the token, shown alongside the prefix.

createdAt
string<date-time>
lastUsedAt
string<date-time> | null

When the key last authenticated a request, or null if never used.

token
string

The secret API key. Store it securely — it is shown only once and cannot be retrieved later.