Documentation | TraceDock

Quickstart

Create a workspace, add a monitor group, choose probe regions, and define the response contract that marks a service as healthy.

curl https://api.tracedock.example/v1/monitors \
  -H "Authorization: Bearer $TRACEDOCK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Public API",
    "url": "https://api.company.example/health",
    "regions": ["fra", "nyc", "sin"],
    "interval_seconds": 60
  }'

Monitors

Monitors run from selected probe regions and evaluate latency, status code, response body, headers, TLS, and DNS records.

Field	Type	Description
`interval_seconds`	integer	Check frequency from 30 to 3600 seconds.
`regions`	array	Probe locations used for quorum-based alerting.
`assertions`	object	Status, header, body, and timing expectations.

Events API

Attach deploy markers, maintenance windows, dependency notes, and incident annotations to the timeline.

POST /v1/events
{
  "service": "billing-api",
  "type": "deploy",
  "summary": "Release 2026.08.13",
  "metadata": {
    "commit": "8fb1c91",
    "owner": "platform"
  }
}

Webhooks

Subscribe to incident lifecycle events, monitor state changes, SLO warnings, and status-page publication events.

Event	When it fires
`incident.created`	A monitor quorum opens an incident.
`incident.resolved`	All affected components return to normal.
`status.updated`	A public or private component status changes.

Status pages

Publish public, private, or customer-specific status pages with component groups, update templates, and subscriber notifications.

Component-level availability and maintenance windows.
Approval flows for customer-facing incident updates.
Custom domain, branding controls, and analytics exports.

Public API

Read-only product metadata endpoints expose service status, public component names, probe regions, and documentation links. Workspace data remains behind token-authenticated /v1 routes.

Endpoint	Description
`GET /api/health`	Service health and current server time.
`GET /api/public/components`	Public component status summaries.
`GET /api/public/regions`	Probe region status and median latency.
`GET /api/public/resources`	Published guides and reference material.

Security

TraceDock supports SAML SSO, SCIM provisioning, role-based access control, audit retention, signed webhooks, and region-aware data processing.