API

Use the CrossWatch REST API from your own self-hosted instance. Includes base URL and the OpenAPI reference link.

Use the CrossWatch API to integrate CrossWatch into your own workflows.

CrossWatch is self-hosted. The API is served by your CrossWatch instance.

It’s not a public, multi-tenant API.

API topics

• Maintenance actions and endpoints: Maintenance

• Legacy inbound endpoints (deprecated): Webhooks

Base URL

Your base URL depends on where you host CrossWatch.

Examples:

• http://localhost:8787 (local dev)

• https://crosswatch.<your-domain> (behind a reverse proxy)

Use HTTPS when exposed beyond localhost. Requests and responses are JSON.

Common endpoints

These endpoints are useful for automation and debugging.

Provider instances (profiles)

• GET /api/provider-instances — list instances for all providers.

• GET /api/provider-instances/{provider} — list instances for one provider.

• POST /api/provider-instances/{provider}/next — create PROV-P## (optionally copy).

• DELETE /api/provider-instances/{provider}/{instance_id} — delete an instance (not default).

Related: Profiles and instances

Watcher (routes mode)

• GET /api/watch/status — routes + group status.

• POST /api/watch/start — start watcher from config.

• POST /api/watch/stop — stop watcher.

• GET /api/watch/logs — tail watch logs.

Insights

• GET /api/insights — insights payload (the dashboard aggregates this).

Related: Insights

Open API reference