API reference

Everything the Atlas web app does, it does through this API — so anything you can see on a page, you can fetch as JSON. The reference below is generated directly from the service's own OpenAPI description, which means it cannot drift from the running code.

Base URL

https://api.atlas.bluesapphiresoftware.net

The web app reaches the same service through a same-origin /api/* proxy, so paths you see in the browser's network tab carry an extra /api prefix that you do not include when calling the API directly.

The specification

The full OpenAPI 3.1 document is served as a static file, so you can point openapi-generator, Postman or your editor's REST client straight at it:

https://docs.atlas.bluesapphiresoftware.net/openapi.json

Download openapi.json

Start here

• Authentication — API keys, and how to send them.
• Conventions — pagination, filtering, dates and errors.
• Then pick a tag from the sidebar for the endpoints themselves.

How this reference is organised

Endpoint pages are generated from the specification and grouped by its tags, which correspond one-to-one with the routers in the service. Tags covering the platform's own machinery are grouped separately at the bottom of the sidebar.

One tag gets no page: mongo. It marks operations backed by the document store rather than describing what they do, so it is applied to 359 of the ~440 operations — a mongo page would be a near-complete copy of every other page. Those endpoints are all documented under their subject tag instead. Nothing else is filtered: if it is in the specification, it has a page.