pods

Create pod API key

Mint an API key scoped to this pod. The key can read and send from the pod's inboxes, create and delete inboxes in this pod, mint/revoke inbox keys for those inboxes, and manage pod/inbox policy and pod-scoped domains. It cannot change webhook config, manage pods, mint further pod keys, reach another pod, or address account-wide policy or domains. The full token is returned once, here — store it securely, it cannot be retrieved again. Requires an account-wide key (a pod-scoped key cannot mint keys).

post/v1/pods/{id}/api-keys

Request

  • Base URL: https://api.openmail.sh
  • URL: https://api.openmail.sh/v1/pods/{id}/api-keys
  • Auth: HTTP bearer

Path parameters

idstring required

Pod ID or your own clientId

Request body

namestring nullable

Human-readable label to identify the key later.

Response

API key created

idstring

OpenMail API key ID

namestring nullable

Human-readable label for the key, if set.

podIdstring nullable

ID of the pod this key is scoped to, or null for an account-wide key. A pod-scoped key can only access resources in this pod.

inboxIdstring nullable

ID of the inbox this key is confined to, or null. When set, the key can only access this single inbox and its threads, messages, and drafts (its podId is the inbox's pod).

tokenPrefixstring

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

last4string

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

createdAtstring date-time
lastUsedAtstring date-time nullable

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

Changes

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