keys

Create an API key

Scope: manage. Not for pending keys. A key can only create keys with scopes it has, and a mailbox-restricted credential can only mint keys for its own mailboxes. Max 100 active keys (409 too_many_keys).

post/v1/keys

Request

  • Base URL: https://botmail.pro
  • URL: https://botmail.pro/v1/keys
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bm_session

Request body

namestring
scopesScope[]

Default ["read", "send"].

mailbox_idsstring[]

Restrict to these mailboxes. Empty = every mailbox (or the caller's own restriction).

Response

Created. secret is shown only once.

idstring required
namestring required
kind'live' | 'pending' required
prefixstring required

First characters of the secret

scopesstring[] required
mailbox_idsstring[] required

Empty = every mailbox.

created_atstring date-time required
last_used_atstring date-time nullable required
last_used_ipstring nullable required
secretstring

bm_live_…. Only in the create response.

Changes

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