For the complete documentation index, see llms.txt. This page is also available as Markdown.

Storage and operations

Files, logs, captures, backups, maintenance, and destructive API operations.

Use these endpoints to manage local CrossWatch storage and operations.

Files and logs

Method
Endpoint
Purpose

GET

/api/files

List a configured storage path.

GET

/api/logs/dump

Return buffered log lines.

GET

/api/logs/stream

Stream one log channel using SSE.

GET

/api/logs/watcher

Stream Watcher log channels using SSE.

Captures and backups

Endpoint group
Purpose

/api/snapshots/*

Create, compare, restore, delete, and clear captures.

/api/backups/*

Create, validate, download, restore, upload, schedule, and retain backups.

Validate a backup before restore. Do not restore while synchronization or capture work is active.

Maintenance

/api/maintenance/* manages local caches, state, tracker data, event storage, and process restarts.

These routes can clear local data or trigger a rebuild. They do not directly remove provider data. A later sync can still apply provider changes after rebuilding local state.

Examples of destructive endpoints include:

  • POST /api/maintenance/clear-state

  • POST /api/maintenance/reset-all-default

  • POST /api/maintenance/restart

  • POST /api/maintenance/events-rebuild

  • POST /api/snapshots/clear

  • POST /api/backups/restore

Use GET /api/maintenance/action-status/{action} to inspect background maintenance work.

Last updated

Was this helpful?