API reference

Use the CW REST API from your own instance, with base URL guidance and the OpenAPI reference.

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

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

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

The API is served by your own CW instance. Base URLs and auth context depend on your deployment.

Quick start

1

Find your base URL

Use your local URL or reverse-proxy URL.

2

Call the endpoint you need

Most requests and responses use JSON.

3

Cross-check in the reference

Use the OpenAPI docs for exact request shapes.

API topics

• Maintenance actions and endpoints: Maintenance
• Inbound playback endpoints: Webhooks

Base URL

Your base URL depends on where you host CW.

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

Related pages

Title

Manage profiles and provider instances

Open

Profiles

Title

Inspect maintenance actions

Open

Maintenance

Title

Review reverse-proxy guidance

Open

Reverse proxy setup

Open API reference