API Reference
The control plane serves 796 routes across 38 areas. Most routes require an authenticated session or API bearer token; agent and webhook routes use their documented protocol credentials, while a small bootstrap set is public. Pick an area below, or start with the conventions that apply everywhere.
Conventions
These rules hold across the whole surface; the tiles link to the guide that owns each of them.
admin, approve, execute, request, audit, or read; public, agent, and webhook use distinct credentials.ScopingSite and environment scopes narrow what a principal sees and touches.PaginationList routes document their own offset or cursor pagination contract.ErrorsOut-of-scope reads return 404; explicit cross-scope writes return 403.Machine-readable spec: openapi.json. It covers the bounded agent, public, and operations-read subset for tooling; it is not a schema for the full route-by-area surface documented on these pages.
Areas
Activity
The global activity audit feed: who-did-what-when records across the platform. Reads require the audit tier.
1 route
Admin
Platform administration: API token and session management, approval groups, delegation boundaries, feature-flag governance, and notification dispatch-outbox introspection. Both reads and mutations under /api/admin require the admin tier.
43 routes
Agents
Routes for Agents.
7 routes
Analytics
AIOps suggestion lifecycle (generate, review, accept, implement, reject) and cost/capacity analytics readouts.
18 routes
Approvals
Cross-domain approval worklist: the pending-approvals queue and the approval decision-readiness contract.
2 routes
Audit
Compliance controls and findings with assessment actions, plus audit-log hash-chain verification.
17 routes
Auth
Session authentication for the portal and API: local and Entra ID/OIDC sign-in and sign-out flows, plus pre-login status, session, and role reads. The sign-in endpoints and pre-login reads are deliberately auth-exempt.
14 routes
Boundary
Reports the platform's execution-boundary status: whether HTTP requests, provider calls, live execution, raw payloads, secret values, and customer identifiers are allowed in the current execution mode.
1 route
Build
Application-environment build lifecycle: plan, approve, deploy, list, and retire application environments, plus the related build contracts.
35 routes
Catalog
The service-catalog read surface: offering categories and definitions, approval routes, the access-control model, and evidence manifests.
12 routes
CMDB
Configuration-management database surface: CI reads and export, impact analysis, reconciliation, relationship graph, file exchange, and ServiceNow integration.
23 routes
Dashboard
Contract endpoints for the portal's global-overview and risk-heatmap dashboards.
2 routes
Datacenter
Datacenter readiness and capacity checks (power, cooling, rack space, switch ports), plus firmware, hardware, out-of-band, storage, network, and image-factory surfaces with per-site readiness reporting.
72 routes
Events
The platform domain-event feed and alert surface: list events and alerts, and acknowledge alerts singly or in batch.
4 routes
Evidence
Evidence-pack operations: collect, export, redact, and verify compliance evidence.
6 routes
Identity
Identity governance: access-review campaigns, reviewer verdicts and recertification, AD computer lifecycle, gMSA lifecycle, file-share/NTFS recertification, and RBAC approval-model contracts.
51 routes
Images
Contract endpoint for the golden-image factory.
1 route
Integrations
External-provider integration management: connection CRUD, health history, credential expiry, circuit breakers, vendor capabilities, adapter readiness and contract tests, plus signed inbound webhooks.
54 routes
Inventory
Inventory coverage and hygiene: coverage summaries, OS baseline compliance, ownership-risk reads, and reconciliation.
8 routes
Maintain
Maintenance operations: OS baseline checks and remediation, patch approval and waves, certificate lifecycle, and approved-software deployment.
47 routes
Me
Self-service endpoints for the signed-in user's own scope preferences; writes are keyed on the verified session identity.
2 routes
Metering
Usage metering and chargeback: usage reads, chargeback reports, and chargeback rate management.
4 routes
Metrics
Metrics budgets (create, update, delete, status) and commitment/consumption readouts.
17 routes
Monitoring
Monitoring configuration: alert-route management, alert reads, noise review, and Zabbix drift contracts.
23 routes
Network
Network services: DNS record management, IPAM, firewall rule sets, and load-balancer surfaces.
41 routes
Notifications
In-app notifications for the signed-in user: list, unread count, and read receipts (single and read-all). Notifications are emitted only by server-side domain logic; recipients mark their own items read.
4 routes
Observe
Observability operations: log-forwarding coverage and gaps, noise suppression, synthetic health dashboards, and the monitoring review queue.
28 routes
Operations
Operational review contracts and readiness reviews across domains, plus the outage-communications notice lifecycle (create, send, acknowledge, cancel, complete).
41 routes
Ops
Operational execution: incident and emergency-change lifecycle, runbook approvals and execution, and the operator shift queue with handover. Emergency routes are admin-tier; the shift queue is operator working data.
42 routes
Patching
Contract endpoints for patching: maintenance calendar, policy import, and reboot orchestration.
4 routes
Platform
Platform status and bootstrap surface: the liveness/readiness/metrics probes registered outside /api, plus platform summary, uptime, degradation drills, and database-readiness reads. The summary read is auth-exempt so the login view can bootstrap before a session exists.
34 routes
Protect
Data protection: backup coverage and gap analysis, DR assignment and plans, restore approvals, and secrets management including rotation.
79 routes
Requests
The governed request lifecycle: create and track requests, validate, plan, approve or reject, execute, verify, cancel, and batch equivalents, with per-request audit trails, approval ledgers, and evidence packs.
34 routes
Retire
Decommissioning lifecycle: plan, approve, and execute decommissions, with quarantine management.
10 routes
Software
Contract endpoint for approved-software deployment.
1 route
Validation
Runs a named validation slice (via the slice query parameter) and returns the validation result; the static dry-run performs no live validation.
1 route
VM
VM day-2 change operations: validate, plan, execute, and verify.
7 routes
Workflows
Workflow contract reads: per-workflow deployment/dry-run contracts and preflight decision surfaces.
6 routes