1.x

API conventions

Stable patterns for Atlas HTTP APIs across minor releases.

Atlas HTTP APIs are resource-oriented, JSON-only, and versioned by URL prefix. Clients should treat undocumented fields as unstable.

Authentication

Send a workspace API token in the Authorization header using the Bearer scheme. Rotate tokens from the dashboard; never embed them in client-side bundles.

Example endpoint

POST/api/v3/projects

Create a project in the active workspace.

Parameter	Type	Description
name	string	Human-readable project name
region	string	Deployment region code

Error envelope

jsonerror.json

{
  "error": {
    "code": "validation_failed",
    "message": "The name field is required.",
    "request_id": "req_01J8YQ"
  }
}

Tip

Always log request_id. Support cannot reconstruct a failure without it.

Release notes

Troubleshooting

Updated Aug 5, 2026