API keys

Create an API key

The secret is returned once and never again. A test-mode key may only create further test-mode keys.

post/api-keys

Request

  • Base URL: https://api.eusend.dev
  • URL: https://api.eusend.dev/api-keys
  • Auth: HTTP bearer

Request body

namestring required
test_modeboolean

Mint an eu_test_ key. A test key can only mint further test keys.

permission'full_access' | 'sending_access'

sending_access reaches the send paths only; every other resource returns 403.

domain_idstring uuid

Restrict the key to one sending domain. Valid only with permission: sending_access.

Response

Created. Store key now.

idstring uuid required
namestring required
keystring required

The secret. Shown once, at creation, and never again.

prefixstring required

First 12 characters, for identifying the key later.

test_modeboolean required
permission'full_access' | 'sending_access' required
domain_idstring uuid nullable
domain_namestring nullable
created_atstring date-time required

Changes

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