Atlas API
Bramble Atlas is IT documentation for MSPs: organisations (your PSA customers) and their people, locations, configurations and flexible assets, the password vault, documents with versions, domains and certificates with expiry checks, files, relationships, and network and rack diagrams.
- Address
https://<your-org>.brambleit.cloud/atlas- Sign-in
- Signed-in browser session (the
sso_session/session_idcookies from Bramble sign-in). - Endpoints
- 86
- OpenAPI
- atlas.json
- Guides
- How Atlas works
Signing in
These endpoints use a signed-in browser session. From your own systems, use Flows webhooks and Bramble steps, or the main API with an API key. See Calling the API.
Organisations are PSA customers and people are PSA contacts — Atlas shares those records with PSA rather than keeping its own.
Secrets are never in list or get responses. Passwords, TOTP seeds and
secret asset fields are only returned by the matching …/reveal (or
…/totp) endpoint, and every reveal is logged with who and when.
Restricted passwords can only be revealed by Atlas admins.
Saving safely. Documents and diagrams take the version you started from
(base_updated_at / base_version); if someone saved in between, you get
409 instead of overwriting their work.
Resources
Home & search
The home page, search across everything, things expiring soon, people (for pickers), and the password generator.
| Method | Path | Summary |
|---|---|---|
| GET | /api/me | Who you are: the signed-in person and what they can do here |
| GET | /api/home | Home page summary |
| GET | /api/search | Search Atlas |
| GET | /api/expiries | Things expiring soon |
| GET | /api/users | People in the tenant (account manager pickers) |
| GET | /api/generate | Generate a strong password |
Organisations
Organisations with their overview, activity, contacts, locations, RMM link, and lists of their assets, passwords, documents, domains and diagrams.
| Method | Path | Summary |
|---|---|---|
| GET | /api/orgs | List organisations |
| POST | /api/orgs | Create an organisation |
| GET | /api/orgs/:id | Get an organisation |
| POST | /api/orgs/:id/logo | The organisation's logo: a PNG/JPEG/WebP (the page scales it to 256 px first), kept as an Atlas file in Blob |
| DELETE | /api/orgs/:id/logo | Remove an organisation's logo |
| PUT | /api/orgs/:id | Update an organisation |
| GET | /api/orgs/:id/overview | The organisation's one-page summary: open tickets, devices, what's running out, what changed, pinned documents |
| GET | /api/orgs/:id/activity | An organisation's recent activity |
| GET | /api/orgs/:id/contacts | An organisation's contacts |
| POST | /api/orgs/:id/contacts | Add a contact |
| GET | /api/orgs/:id/locations | An organisation's locations |
| POST | /api/orgs/:id/locations | Add a location |
| GET | /api/orgs/:id/rmm | The organisation's RMM sites and devices |
| POST | /api/orgs/:id/rmm/link-site | Link an RMM site to the organisation |
| POST | /api/orgs/:id/rmm/unlink-site | Unlink an RMM site |
| POST | /api/orgs/:id/rmm/import | Import RMM devices as configurations |
| GET | /api/orgs/:id/assets | An organisation's assets |
| POST | /api/orgs/:id/assets | Add an asset |
| GET | /api/orgs/:id/passwords | An organisation's passwords |
| POST | /api/orgs/:id/passwords | Add a password to an organisation |
| GET | /api/orgs/:id/documents | An organisation's documents |
| POST | /api/orgs/:id/documents | Add a document to an organisation |
| GET | /api/orgs/:id/domains | An organisation's domains |
| POST | /api/orgs/:id/domains | Add a domain |
| GET | /api/orgs/:id/diagrams | An organisation's diagrams |
| POST | /api/orgs/:id/diagrams | Create a diagram |
| GET | /api/orgs/:id/diagram-sources | Everything the editor's side panels and live overlay need |
| GET | /api/orgs/:id/diagram-status | Live state of the assets on a diagram (polled by the editor) |
| POST | /api/orgs/:id/diagrams/generate | Draw a diagram from network data |
Contacts
People and locations at an organisation.
| Method | Path | Summary |
|---|---|---|
| GET | /api/contacts/:id | Get a contact |
| PUT | /api/contacts/:id | Update a contact |
| DELETE | /api/contacts/:id | Delete a contact |
| PUT | /api/locations/:id | Update a location |
| DELETE | /api/locations/:id | Delete a location |
Configurations & assets
Configurations (servers, workstations, network kit…) and flexible assets of any type your admins define. Assets can be linked to RMM devices and kept in step with them, and related to each other.
| Method | Path | Summary |
|---|---|---|
| GET | /api/assets/:id | Get an asset |
| PUT | /api/assets/:id | Update an asset |
| POST | /api/assets/:id/reveal | Reveal a secret field |
| DELETE | /api/assets/:id | Delete an asset |
| POST | /api/assets/:id/rmm-sync | Update an asset from its RMM device |
| POST | /api/assets/:id/rmm-link | Link an asset to an RMM device |
| GET | /api/relations | What a record is related to |
| POST | /api/relations | Relate two records |
| DELETE | /api/relations/:id | Remove a relation |
| GET | /api/assets/:id/diagrams | Diagrams an asset appears on (asset page) |
Password vault
Stored passwords, with TOTP codes. Values are encrypted; reading one is a separate, logged reveal.
| Method | Path | Summary |
|---|---|---|
| GET | /api/passwords | Passwords that belong to no organisation: the MSP's own (distributors, vendor portals...) |
| GET | /api/passwords/:id | Get a password's details (not its value) |
| POST | /api/passwords | Add a password with no organisation |
| PUT | /api/passwords/:id | Update a password |
| DELETE | /api/passwords/:id | Delete a password |
| POST | /api/passwords/:id/reveal | Reveal a password |
| POST | /api/passwords/:id/totp | Current TOTP code for a password |
Documents
Documents and procedures with full version history. Library documents can be copied into an organisation.
| Method | Path | Summary |
|---|---|---|
| GET | /api/documents | Library documents |
| GET | /api/documents/:id | Get a document |
| POST | /api/documents | Add a library document |
| PUT | /api/documents/:id | Save a document |
| DELETE | /api/documents/:id | Archive a document |
| GET | /api/documents/:id/versions | A document's versions |
| GET | /api/documents/:id/versions/:vid | Get a document version |
| POST | /api/documents/:id/versions/:vid/restore | Restore a document version |
| POST | /api/documents/:id/copy | Copy a library document (e.g |
Domains & certificates
Domains and their SSL certificates, checked daily (registration expiry from RDAP, certificate from port 443).
| Method | Path | Summary |
|---|---|---|
| PUT | /api/domains/:id | Update a domain |
| POST | /api/domains/:id/check | Check a domain and its certificate now |
| DELETE | /api/domains/:id | Delete a domain |
Diagrams
Network diagrams and rack layouts with versions. "Generate" draws a starting diagram from Atlas assets, RMM network discovery and UniFi topology.
| Method | Path | Summary |
|---|---|---|
| GET | /api/diagrams/:id | Get a diagram |
| PUT | /api/diagrams/:id | Save a diagram |
| DELETE | /api/diagrams/:id | Archive a diagram |
| POST | /api/diagrams/:id/duplicate | Copy a diagram |
| GET | /api/diagrams/:id/versions | A diagram's versions |
| GET | /api/diagrams/:id/versions/:vid | Get a diagram version |
| POST | /api/diagrams/:id/versions/:vid/restore | Restore a diagram version |
Files
Attachments on any record, stored encrypted in Bramble.
| Method | Path | Summary |
|---|---|---|
| GET | /api/files | Files on a record |
| POST | /api/files | Attach a file |
| GET | /api/files/:id | Download a file |
| DELETE | /api/files/:id | Delete a file |
Admin
Asset types and their fields, Atlas settings and storage. Needs Global Administrator or Atlas Admin.
| Method | Path | Summary |
|---|---|---|
| GET | /api/admin/overview | Atlas admin overview |
| POST | /api/admin/types | Create an asset type |
| PUT | /api/admin/types/:id | Update an asset type |
| PUT | /api/admin/settings | Update Atlas settings |
| GET | /api/admin/storage | What Atlas keeps in BRM-Blob: Blob's own figures for app "atlas" (used, any Atlas limit, the tenant pool) plus a breakdown from the files table by kind and o… |
| POST | /api/admin/storage/free | Deletes the files counted in "spare": attachments of records deleted more than 30 days ago, and document images that were never saved into a document |
Web pages
These return pages for the browser rather than data.
GET /GET /sw.js