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

Use the regional endpoint assigned to your project. The endpoint picker in the header updates examples throughout these docs.

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

Every non-successful response uses the same JSON envelope. Use name for programmatic handling, show message when it helps the developer, and inspect errors for field-level validation details.

Error response

json

{
  "name": "validation_error",
  "message": "The request could not be validated.",
  "errors": {
    "to": ["Enter at least one valid recipient."]
  }
}

Error response fields

FieldTypeDescription

namerequiredstring

messagerequiredstring

errorsobject

HTTP status codes

400

Bad requestThe request body is malformed or cannot be parsed.

401

UnauthorizedThe bearer token is missing, expired, or invalid.

403

ForbiddenThe key cannot access the requested project resource.

404

Not foundThe requested resource does not exist in this project.

409

ConflictThe request conflicts with the current resource state.

410

GoneThe requested resource is no longer available.

422

Validation errorOne or more request fields failed validation.

5xx

Server errorA transient regional service error interrupted the request.

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.