Documentation/API reference

API reference

The Boundry API is regional by design. Authenticate every request with a project API key and send it to the regional endpoint for that project.

Base URL

Configured endpointhttps://api.au.boundry.dev

Authentication

Pass the project API key as a bearer token. A key is scoped to one project and only accesses that project’s regional data plane.

Request header

bash

Authorization: Bearer $BOUNDRY_API_KEY

Errors

Errors use a standard envelope. The errors array provides per-field validation details when available.

FieldTypeDescription

errorsarray

Detailed validation issues. Absent only for the historical 401 API-key envelope.

coderequiredstring

Zod validation issue code. Example: "invalid_format".

messagerequiredstring

Human-readable validation failure. Example: "Invalid email address".

pathrequiredstring

Dot-separated location of the invalid value. Example: "from".

messagerequiredstring

Human-readable error message. Example: "Request validation failed.".

namerequiredstring

Machine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".

Idempotency and retries

For operations that accept Idempotency-Key, reuse the same key when retrying a request after an uncertain network failure. Retry transient 5xx responses with backoff; do not retry validation errors without changing the request.

Operations

GET/api-keys

List API keys

→POST/api-keys

Create an API key

→DELETE/api-keys/{keyId}

Delete an API key

→GET/domains

List domains

→POST/domains

Create a domain

→DELETE/domains/{domainId}

Delete a domain

→GET/domains/{domainId}

Get a domain

→PATCH/domains/{domainId}

Update domain tracking

→POST/domains/{domainId}

Verify a domain (compatibility action)

→POST/domains/{domainId}/verify

Verify a domain

→GET/emails

List sent emails

→POST/emails

Send an email

→GET/emails/{emailId}

Get a sent email

→GET/emails/{emailId}/attachments

List email attachments

→GET/emails/{emailId}/attachments/{attachmentId}

Download an email attachment

→POST/emails/batch

Send a batch of emails

→GET/events

List project events

→GET/events/{eventId}

Get a project event

→GET/emails/receiving

List received emails

→GET/emails/receiving/{emailId}

Get a received email

→POST/inbound

Ingest an inbound email

→GET/logs

List event logs

→GET/openapi.json

Get the OpenAPI document

→GET/webhooks

List webhooks

→POST/webhooks

Create a webhook

→DELETE/webhooks/{webhookId}

Delete a webhook

→GET/webhooks/{webhookId}

Get a webhook

→PATCH/webhooks/{webhookId}

Update a webhook

→GET/webhooks/{webhookId}/deliveries

List webhook deliveries

→GET/webhooks/{webhookId}/deliveries/{deliveryId}

Get webhook delivery detail

→POST/webhooks/{webhookId}/deliveries/{deliveryId}/retry

Retry a webhook delivery

→POST/webhooks/{webhookId}/rotate-secret

Rotate a webhook signing secret

→POST/webhooks/{webhookId}/test

Send a synthetic webhook event

→POST/webhooks/{webhookId}/verify

Send a webhook ownership challenge

→