v2.0.0
OpenAPI 3.1.1

CriticalArc SafeZone API

Operations are grouped by tag; each tag describes its area.

Responses

A successful response is an envelope carrying the payload in data. An error is RFC 9457 application/problem+json: branch on type, and read errors for per-field validation messages. Every response carries a request_id — quote it in support requests.

Authentication

Send a JWT bearer token. An operation you hold no permission for answers 403.

Pagination

A paged response carries its rows in items. Where more remains it also carries a next_cursor: send that back as the request's cursor to read the next page, leaving the rest of the request as you first sent it, because a cursor is bound to the request that produced it. A response with no next_cursor is the last page. A .../list operation takes its filters in the body — send {} for the first page of everything, and max to size the page.

Machine-readable metadata

Every operation declares an x-safety block — whether it mutates, how it is reversed, what it causes beyond the record it writes, and what its response discloses — against the vocabulary in x-safety-contract at the root of this document, and an x-permissions block naming the permissions it needs. Automated callers should gate on both.

Server:https://{subdomain}.criticalarc.net

Set {subdomain} to your tenant's subdomain CNAME (e.g. eastuniversity) or an explicit region (sz-au, sz-uk, sz-us). Avoid the geo-routing alias "safezone": it resolves to the nearest region, which may not host your tenant. Every request then fails with 403 urn:criticalarc:problems:wrong-region, whose host member carries the base URI to send it to.

Client Libraries

Asset History (Collapsed)

​

Time-ranged asset history, point-in-time snapshots, and per-region presence-duration reports.

Notifications (Collapsed)

​

Sending a notification and searching what a SafeZone has sent, with the per-notification delivery report; and the templates, categories, tokens and subscription groups a notification is composed and addressed from.

User Images (Collapsed)

​

Utility (Collapsed)

​

Service liveness probe and phone-number metadata helpers.

Models