API Reference

Consolidated reference for CrossWatch HTTP endpoints.

CrossWatch exposes an HTTP API from your self-hosted instance.

If you want an interactive explorer, use:

• Swagger UI: GET /docs

• OpenAPI spec: GET /openapi.json

Conventions

• Base URL: https://<your-crosswatch-host>

• Requests and responses are JSON unless noted.

• Validation errors use FastAPI’s default 422 format.

Endpoint groups

Use these pages as the “human” reference. The OpenAPI docs remain the source of truth.

• App Auth

• Auth

• Config

• Editor

• Export

• Files

• Insight

• Logging

• Maintenance

• Media providers

• Metadata

• Probes

• Scrobbler

• Snapshots

• Synchronization

• UI

• Version

• Wall