Your AWS SES. Your dedicated Mailat. See how it works
Documentation

Create APIKey

Request, response and authentication details for your Mailat instance.

← All API operations
POST/api/v1/api-keys

CreateAPIKey generates a new API key POST /api/v1/api-keys

Authentication & compatibility

This operation requires an active human session. API keys cannot call it. Additional role or MFA checks may apply.

Mailat application, account or shared resource API. Individual operations can require configured external services; this label is not a runtime-readiness guarantee.

Contract 2026-10-04. Your running instance's /api/v1/openapi.json is authoritative for its deployed release.

Request

Set MAILAT_BASE_URL to your instance origin (without /api/v1) and MAILAT_TOKEN to an appropriate credential. Replace path placeholders and example data before running. These examples do not execute in this page.

cURL request
curl --request POST "$MAILAT_BASE_URL/api/v1/api-keys" \
  --header "Authorization: Bearer $MAILAT_TOKEN" \
  --header 'Content-Type: application/json' \
  --data @request.json

Build the request from the schema below; request.json and upload paths are local placeholders.

Request body (required)

application/json

bodyobjectrequired
Fields · model.CreateApiKeyRequest
expiresAtall of · nullable

Optional future RFC3339 expiry. Null means no expiry.

Variant 1string
namestringrequired

minLength: 2

permissionsarrayrequired

minItems: 1

Each itemstring

Allowed: "contacts:manage" | "domains:manage" | "domains:read" | "email:manage" | "email:read" | "email:send" | "identities:manage" | "identities:read" | "templates:manage" | "templates:read" | "webhooks:manage"

rateLimitinteger (int64)

Requests per minute. Omit or use 0 for 100; otherwise 1–10000.

Default: 100

minimum: 0 · maximum: 10000

Responses

HTTP statuses and body shapes below come from the pinned contract. Not every shared error applies to every request. Retain the original idempotency key when retrying a send.

200 · Success

application/json

responseobject
Fields
codeintegerrequired
dataall of · nullable
Variant 1object
Fields · model.ApiKeyResponse
createdAtstring (date-time)
expiresAtall of · nullable
Variant 1string (date-time)
idinteger (int64)
keystring

Only shown on creation

keyPrefixstring
lastUsedAtall of · nullable
Variant 1string (date-time)
namestring
permissionsarray
Each itemstring
rateLimitinteger (int64)
uuidstring
messagestringrequired
400 · Invalid input

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
401 · Missing, expired or revoked authentication

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
403 · Insufficient permission

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
404 · Resource not found

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
409 · Conflict or changed idempotency payload

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
410 · Recovery cursor expired; resynchronize

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
429 · Rate limit exceeded; respect Retry-After
Header: Retry-Afterinteger

Seconds until the next fixed-minute request window.

minimum: 1

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
500 · Internal failure; retain the idempotency key

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
Download the full OpenAPI contract