API explorer

Every endpoint of the CamelMailer API v2: 106 operations, straight from the OpenAPI spec. Pick an endpoint, copy a snippet, or send a live request from your browser.

Send

get/api/v2/server/#

Show the authenticated server

AuthX-Server-API-Key

Responses

200Success envelope; see the endpoint description for the data shape.
401Missing or invalid credentials

get/api/v2/server/ping#

Validate the server API key

AuthX-Server-API-Key

Responses

200Success envelope; see the endpoint description for the data shape.
401Missing or invalid credentials

post/api/v2/server/messages#

Send a message

Queues one message per recipient. The from domain must be a verified sending domain of the server.

AuthX-Server-API-Key

Request body

fromstring · email | objectrequiredEither a bare email string or an object with a display name.
toarray<string · email | object>required
ccarray<string · email | object>
bccarray<string · email | object>
reply_toarray<string · email | object>
subjectstring
html_bodystring
text_bodystring
headersobject
attachmentsarray<object>
tagstringFree-form tag for filtering/stats
metadataobject
streamstringMessage-stream permalink (defaults to the server's default stream)

Example request

{
  "from": "billing@acme.com",
  "to": [
    "ada@example.com"
  ],
  "subject": "Your receipt",
  "text_body": "Thanks for your purchase.",
  "tag": "receipt"
}

Responses

201Queued
401Missing or invalid credentials
422The request was understood but invalid

post/api/v2/server/messages/batch#

Send a batch of messages

An array of send requests; returns one result per entry.

AuthX-Server-API-Key

Request body

messagesarray<object>

Example request

{
  "messages": [
    {
      "from": "user@example.com",
      "to": [
        "user@example.com"
      ]
    }
  ]
}

Responses

200Success envelope; see the endpoint description for the data shape.
401Missing or invalid credentials

post/api/v2/server/messages/with_template#

Send using a stored template

Renders the named template (Mustache-style {{ variables }}) against template_model, then sends. Fields set directly (e.g. subject) override the rendered ones.

AuthX-Server-API-Key

Request body

fromstring · email | objectrequiredEither a bare email string or an object with a display name.
toarray<string · email | object>required
ccarray<string · email | object>
bccarray<string · email | object>
reply_toarray<string · email | object>
subjectstring
html_bodystring
text_bodystring
headersobject
attachmentsarray<object>
tagstringFree-form tag for filtering/stats
metadataobject
streamstringMessage-stream permalink (defaults to the server's default stream)
templatestringrequiredTemplate permalink
template_modelobject

Example request

{
  "from": "hello@acme.com",
  "to": [
    "ada@example.com"
  ],
  "template": "welcome",
  "template_model": {
    "name": "Ada",
    "product": "Acme"
  }
}

Responses

201Success envelope; see the endpoint description for the data shape.
401Missing or invalid credentials
404Resource not found
422The request was understood but invalid

post/api/v2/server/messages/with_template/batch#

Send a template to many recipients (batch)

AuthX-Server-API-Key

Responses

200Success envelope; see the endpoint description for the data shape.
401Missing or invalid credentials

Messages

get/api/v2/server/messages#

List messages

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`page`	query	integer	—
`per_page`	query	integer	—
`scope`	query	stringincoming \| outgoing	—
`status`	query	string	—
`tag`	query	string	—
`query`	query	string	Substring match on subject / addresses
`stream`	query	string	Message-stream permalink

Responses

200Messages
401Missing or invalid credentials

get/api/v2/server/messages/{id}#

Show a message

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.
404Resource not found

get/api/v2/server/messages/{id}/deliveries#

Delivery attempts of a message

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.
404Resource not found

get/api/v2/server/messages/{id}/opens#

Open events of a message

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

get/api/v2/server/messages/{id}/clicks#

Click events of a message

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

get/api/v2/server/messages/{id}/raw#

Raw RFC 5322 source of a message

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.
404Resource not found

Inbound

get/api/v2/server/inbound#

Search inbound / held messages

AuthX-Server-API-Key

Responses

200Success envelope; see the endpoint description for the data shape.

get/api/v2/server/inbound/{id}#

Show an inbound message

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/server/inbound/{id}/retry#

Requeue an inbound message for delivery

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/server/inbound/{id}/bypass#

Bypass a hold and deliver

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

Stats

get/api/v2/server/stats#

Message counters

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`from`	query	string · date-time	—
`to`	query	string · date-time	—

Responses

200Counters

get/api/v2/server/stats/deliveries#

Delivery/queue statistics

AuthX-Server-API-Key

Responses

200Success envelope; see the endpoint description for the data shape.

get/api/v2/server/bounces#

List bounce messages

AuthX-Server-API-Key

Responses

200Success envelope; see the endpoint description for the data shape.

get/api/v2/server/bounces/{id}#

Show a bounce

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

Streams

get/api/v2/server/streams#

List message streams

AuthX-Server-API-Key

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/server/streams#

Create a message stream

AuthX-Server-API-Key

Request body (optional)

namestringrequired
stream_typestring"transactional" | "broadcast"

Example request

{
  "name": "string"
}

Responses

201Success envelope; see the endpoint description for the data shape.

get/api/v2/server/streams/{permalink}#

Show a stream

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`permalink`required	path	string	—

Responses

200Success envelope; see the endpoint description for the data shape.

patch/api/v2/server/streams/{permalink}#

Update a stream

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`permalink`required	path	string	—

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/server/streams/{permalink}/archive#

Archive a stream

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`permalink`required	path	string	—

Responses

200Success envelope; see the endpoint description for the data shape.

Templates

get/api/v2/server/templates#

List templates

AuthX-Server-API-Key

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/server/templates#

Create a template

AuthX-Server-API-Key

Request body (optional)

namestringrequired
subjectstringMay contain {{ variables }}
html_bodystring
text_bodystring

Example request

{
  "name": "string"
}

Responses

201Success envelope; see the endpoint description for the data shape.

get/api/v2/server/templates/{permalink}#

Show a template

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`permalink`required	path	string	—

Responses

200Success envelope; see the endpoint description for the data shape.

patch/api/v2/server/templates/{permalink}#

Update a template

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`permalink`required	path	string	—

Request body (optional)

namestringrequired
subjectstringMay contain {{ variables }}
html_bodystring
text_bodystring

Example request

{
  "name": "string"
}

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/server/templates/{permalink}/archive#

Archive a template

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`permalink`required	path	string	—

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/server/templates/{permalink}/render#

Render a template against a model (preview)

AuthX-Server-API-Key

Parameters

Parameter	In	Type	Description
`permalink`required	path	string	—

Request body (optional)

template_modelobject

Example request

{
  "template_model": {}
}

Responses

200Success envelope; see the endpoint description for the data shape.

Auth

post/api/v2/auth/login#

Sign in with email + password (+ optional TOTP)

Request body

email_addressstring · emailrequired
passwordstringrequired
totp_codestringRequired when 2FA is enabled

Example request

{
  "email_address": "user@example.com",
  "password": "string"
}

Responses

201Session created
401InvalidCredentials / TOTPRequired / InvalidTOTPCode
403AccountLocked

post/api/v2/auth/logout#

Revoke the current session

AuthAuthorization: Bearer …

Responses

200Success envelope; see the endpoint description for the data shape.

get/api/v2/auth/me#

Current user + memberships

AuthAuthorization: Bearer …

Responses

200Success envelope; see the endpoint description for the data shape.

patch/api/v2/auth/me#

Update profile

AuthAuthorization: Bearer …

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/auth/password#

Change password (revokes all sessions, returns a fresh token)

AuthAuthorization: Bearer …

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/auth/password-reset#

Request a password reset (identical response for unknown addresses)

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/auth/password-reset/complete#

Redeem a reset token

Responses

200Success envelope; see the endpoint description for the data shape.
422The request was understood but invalid

post/api/v2/auth/totp/enroll#

Start TOTP enrollment (returns secret + otpauth URL)

AuthAuthorization: Bearer …

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/auth/totp/activate#

Confirm TOTP with a code — 2FA is enforced from here on

AuthAuthorization: Bearer …

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/auth/totp/disable#

Disable TOTP (requires the password)

AuthAuthorization: Bearer …

Responses

200Success envelope; see the endpoint description for the data shape.

get/api/v2/auth/invitations/{token}#

Preview an invitation (public)

Parameters

Parameter	In	Type	Description
`token`required	path	string	—

Responses

200Success envelope; see the endpoint description for the data shape.
422The request was understood but invalid

post/api/v2/auth/invitations/accept#

Accept an invitation (creates the account when new)

Responses

200Success envelope; see the endpoint description for the data shape.
422The request was understood but invalid

get/api/v2/auth/oidc/start#

Begin OIDC SSO (redirect, or JSON with Accept application/json)

Responses

200Success envelope; see the endpoint description for the data shape.
307Redirect to the identity provider
404SSODisabled

get/api/v2/auth/oidc/callback#

OIDC redirect URI (completes SSO)

Responses

201Success envelope; see the endpoint description for the data shape.
307Redirect to the frontend with the token in the fragment

Organizations

get/api/v2/admin/organizations#

List organizations (users see their memberships)

AuthX-Admin-API-KeyAuthorization: Bearer …

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations#

Create an organization (a user creator becomes its owner)

AuthX-Admin-API-KeyAuthorization: Bearer …

Responses

201Success envelope; see the endpoint description for the data shape.

get/api/v2/admin/organizations/{org}#

Show an organization

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink

Responses

200Success envelope; see the endpoint description for the data shape.

DEL/api/v2/admin/organizations/{org}#

Delete an organization (owner)

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink

Responses

200Success envelope; see the endpoint description for the data shape.

Servers

get/api/v2/admin/organizations/{org}/servers#

List mail servers

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations/{org}/servers#

Create a mail server

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink

Responses

201Success envelope; see the endpoint description for the data shape.

get/api/v2/admin/organizations/{org}/servers/{server}#

Show a server

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

200Success envelope; see the endpoint description for the data shape.

patch/api/v2/admin/organizations/{org}/servers/{server}#

Update server settings

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

200Success envelope; see the endpoint description for the data shape.

DEL/api/v2/admin/organizations/{org}/servers/{server}#

Delete a server

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations/{org}/servers/{server}/suspend#

Suspend sending

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations/{org}/servers/{server}/unsuspend#

Lift a suspension

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations/{org}/servers/{server}/ip_pool#

Assign an IP pool

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

200Success envelope; see the endpoint description for the data shape.

Domains

get/api/v2/admin/organizations/{org}/servers/{server}/domains#

List sending domains

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations/{org}/servers/{server}/domains#

Add a sending domain

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

201Success envelope; see the endpoint description for the data shape.

get/api/v2/admin/organizations/{org}/servers/{server}/domains/{name}#

Show a domain

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink
`name`required	path	string	—

Responses

200Success envelope; see the endpoint description for the data shape.

DEL/api/v2/admin/organizations/{org}/servers/{server}/domains/{name}#

Delete a domain

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink
`name`required	path	string	—

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations/{org}/servers/{server}/domains/{name}/verify#

Mark a domain verified

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink
`name`required	path	string	—

Responses

200Success envelope; see the endpoint description for the data shape.

Credentials

get/api/v2/admin/organizations/{org}/servers/{server}/credentials#

List credentials

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations/{org}/servers/{server}/credentials#

Create a credential (API, SMTP or SMTP-IP)

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

201Success envelope; see the endpoint description for the data shape.

get/api/v2/admin/organizations/{org}/servers/{server}/credentials/{id}#

Show a credential

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

patch/api/v2/admin/organizations/{org}/servers/{server}/credentials/{id}#

Update a credential (name, hold)

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

DEL/api/v2/admin/organizations/{org}/servers/{server}/credentials/{id}#

Delete a credential

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

Routes

get/api/v2/admin/organizations/{org}/servers/{server}/routes#

List inbound routes

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations/{org}/servers/{server}/routes#

Create a route

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

201Success envelope; see the endpoint description for the data shape.

get/api/v2/admin/organizations/{org}/servers/{server}/routes/{id}#

Show a route

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

patch/api/v2/admin/organizations/{org}/servers/{server}/routes/{id}#

Update a route

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

DEL/api/v2/admin/organizations/{org}/servers/{server}/routes/{id}#

Delete a route

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

Webhooks

get/api/v2/admin/organizations/{org}/servers/{server}/webhooks#

List webhooks

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations/{org}/servers/{server}/webhooks#

Create a webhook

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

201Success envelope; see the endpoint description for the data shape.

get/api/v2/admin/organizations/{org}/servers/{server}/webhooks/{id}#

Show a webhook

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

DEL/api/v2/admin/organizations/{org}/servers/{server}/webhooks/{id}#

Delete a webhook

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations/{org}/servers/{server}/webhooks/{id}/enable#

Enable a webhook

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations/{org}/servers/{server}/webhooks/{id}/disable#

Disable a webhook

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

Suppressions

get/api/v2/admin/organizations/{org}/servers/{server}/suppressions#

List suppressions

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations/{org}/servers/{server}/suppressions#

Suppress an address

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink

Responses

201Success envelope; see the endpoint description for the data shape.

DEL/api/v2/admin/organizations/{org}/servers/{server}/suppressions/{address}#

Remove a suppression

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`server`required	path	string	Server permalink
`address`required	path	string	—

Responses

200Success envelope; see the endpoint description for the data shape.

People

get/api/v2/admin/organizations/{org}/members#

List members

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations/{org}/members#

Add an existing account as a member (admin)

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink

Responses

201Success envelope; see the endpoint description for the data shape.

patch/api/v2/admin/organizations/{org}/members/{user_id}#

Change a member's role (owner transitions need an owner)

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`user_id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

DEL/api/v2/admin/organizations/{org}/members/{user_id}#

Remove a member (the last owner is immovable)

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`user_id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

get/api/v2/admin/organizations/{org}/invitations#

List invitations

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/organizations/{org}/invitations#

Invite by email (invite token returned exactly once)

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink

Responses

201Success envelope; see the endpoint description for the data shape.

DEL/api/v2/admin/organizations/{org}/invitations/{id}#

Revoke an invitation

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`org`required	path	string	Organization permalink
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

Instance

get/api/v2/admin/users#

List user accounts (instance admins)

AuthX-Admin-API-KeyAuthorization: Bearer …

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/users#

Create a user (optional initial password)

AuthX-Admin-API-KeyAuthorization: Bearer …

Responses

201Success envelope; see the endpoint description for the data shape.

get/api/v2/admin/users/{id}#

Show a user

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

patch/api/v2/admin/users/{id}#

Update a user

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

DEL/api/v2/admin/users/{id}#

Delete a user

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

get/api/v2/admin/ip_pools#

List IP pools

AuthX-Admin-API-KeyAuthorization: Bearer …

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/ip_pools#

Create an IP pool

AuthX-Admin-API-KeyAuthorization: Bearer …

Responses

201Success envelope; see the endpoint description for the data shape.

get/api/v2/admin/ip_pools/{id}#

Show an IP pool

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

DEL/api/v2/admin/ip_pools/{id}#

Delete an IP pool

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

get/api/v2/admin/ip_pools/{pool_id}/ip_addresses#

List addresses of a pool

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`pool_id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/ip_pools/{pool_id}/ip_addresses#

Add an address to a pool

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`pool_id`required	path	integer	—

Responses

201Success envelope; see the endpoint description for the data shape.

get/api/v2/admin/ip_pools/{pool_id}/ip_addresses/{id}#

Show an address

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`pool_id`required	path	integer	—
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

DEL/api/v2/admin/ip_pools/{pool_id}/ip_addresses/{id}#

Remove an address

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`pool_id`required	path	integer	—
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

get/api/v2/admin/admin_api_keys#

List admin API keys

AuthX-Admin-API-KeyAuthorization: Bearer …

Responses

200Success envelope; see the endpoint description for the data shape.

post/api/v2/admin/admin_api_keys#

Create an admin API key (secret returned once)

AuthX-Admin-API-KeyAuthorization: Bearer …

Responses

201Success envelope; see the endpoint description for the data shape.

DEL/api/v2/admin/admin_api_keys/{id}#

Revoke an admin API key

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`id`required	path	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

get/api/v2/admin/auth_events#

Authentication audit trail (instance admins)

AuthX-Admin-API-KeyAuthorization: Bearer …

Parameters

Parameter	In	Type	Description
`limit`	query	integer	—

Responses

200Success envelope; see the endpoint description for the data shape.

General

get/health#

Liveness probe

Unauthenticated; never touches storage.

Responses

200Instance is up