API
API reference
The REST API, grouped the way the OpenAPI document tags it. Each page lists its operations with method and path, and who may call them. Routes sit at the root, with no /api prefix.
- Base URL
- https://chorus-api.fleetworks.dev
- Areas
- 7
- Operations
- 30
- Records5 opsCreate, list, edit, delete and chmod DNS records under the organization’s domains. Listing can attach lint findings.
- Domains4 opsList the organization’s domains, and create, rename or delete them.
- Public directory2 opsSearch published records and list published domains. Responses carry only allowlisted fields.
- Webhooks7 opsRegister HTTPS endpoints for events, send a test delivery and read recent delivery attempts.
- Organization members3 opsList the organization’s members and grant or revoke their roles.
- Moderation7 opsReport a record, block another user’s records, accept the terms, and work the moderation queue.
- Device tokens2 opsRegister or remove a mobile push token, so the organization’s devices are alerted when a delivery is dead-lettered.
Outside the spec
The API also serves these routes, which the vendored OpenAPI document does not list.
- GET/healthHealth check; reports the webhook delivery modeNo credentials
- GET/openapi.jsonThe OpenAPI document itselfNo credentials
- GET/api/meThe caller’s roles and whether they belong to an organizationA signed-in user or a PAT