Skip to main content
The public API is versioned in the URL. The current version is /v1.

​
Compatible changes

Watchdog may make additive changes within a version, including:
  • Adding an endpoint.
  • Adding an optional request field.
  • Adding a response field or error code.
  • Expanding human-readable descriptions and examples.
Clients should ignore response fields they do not recognize and branch only on documented machine-readable values.

​
Breaking changes

A change that requires existing clients to change behavior belongs in a new version or a documented migration. Examples include removing a field, changing its meaning, or making an optional input required.

​
Runtime contract

GET /doc is the public OpenAPI 3.1 source of truth for request and response shapes. This site rebuilds from that hosted contract after successful Watchdog production deployments.
Authored guides explain how to use the API. When an authored example and the generated endpoint schema disagree about a wire shape, follow the generated schema and report the documentation mismatch.