API
Operations & Reliability
API versioning, deprecation policy, rate limits, reliability guarantees and service status — what to build against in production.
Everything an integration needs to run against WatchFor in production.
Versioning
The API is versioned in the path: https://watchfor.io/api/v1.
- Additive changes are not breaking — new endpoints, new optional
parameters and new response fields can appear within
v1at any time. Parse responses leniently: ignore fields you don't recognise. - Breaking changes get a new version path (
/api/v2).v1keeps working alongside it. - The machine-readable contract is the OpenAPI spec at
/openapi.json— regenerated with every deploy, always current.
Deprecation policy
If an endpoint or field must ever be retired within a version, it will be:
- announced in the changelog and marked deprecated in the OpenAPI spec first,
- kept working for at least 90 days after the announcement,
- removed only in the next version path if it's a breaking removal.
Rate limits
- Per-plan request budget, applied per API key:
apiRequestsPerMinute(default 60/min). Current limits are visible onGET /v1/plan. - Every response carries
X-RateLimit-LimitandX-RateLimit-Remaining. - On
429you also getRetry-After(seconds). Back off and retry — paired with theIdempotency-Keyheader on POSTs, retries are safe. - The MCP server shares the same budget (its tools call the API internally).
Reliability
- Checks run from multiple independent probe locations worldwide; an outage is only declared after multi-location confirmation, so API incident data reflects real outages rather than one bad network path.
- The control plane runs on EU infrastructure (GDPR applies) with redundant application replicas behind a load balancer.
- Mutating endpoints support the
Idempotency-Keyheader (Stripe semantics, 24h window) so network retries can never double-create. - Write operations are recorded in the org
activity log — every API-key
action is auditable via
GET /v1/activity.
Service status
Live platform status, incident history and maintenance announcements: status page — powered by WatchFor status pages themselves.
Support
- Security contact:
/.well-known/security.txt - General: [email protected]
- Error semantics: see Errors