Getting started
SysOS REST API
The SysOS API is organised around REST. It uses resource-oriented URLs, returns JSON, and relies on standard HTTP verbs and status codes.
Base URL
BASEhttps://api.sysos.app/v1
All endpoints are versioned under /v1. Breaking changes ship under a new
version prefix; additive changes do not.
Conventions
| Topic | Behaviour |
|---|---|
| Format | All requests and responses are application/json. |
| IDs | Opaque strings, e.g. usr_8c71e4f9. Do not parse them. |
| Timestamps | ISO 8601 UTC, e.g. 2026-03-01T18:25:43Z. |
| Verbs | GET read, POST create, PATCH update, DELETE remove. |