1. API Reference
  2. API resources
  3. Checks
Website
  • API overview
  • API quickstart
  • Authentication
  • Project scoping
  • Requests and responses
  • Pagination and filtering
  • Errors
  • GETList supported database engines
  • POSTList projects
  • POSTCreate a project
  • GETGet a project
  • DELETEDelete a project
  • PATCHUpdate a project
  • POSTCreate a source
  • POSTList sources
  • GETGet source details
  • DELETEDelete a source
  • PATCHUpdate a source
  • POSTCreate secret metadata
  • POSTList secret metadata
  • GETGet secret metadata
  • DELETEDelete secret metadata
  • PATCHUpdate secret metadata
  • POSTCreate a schedule
  • POSTList schedules
  • POSTSummarize schedule statuses
  • GETGet a schedule
  • DELETEDelete a schedule
  • PATCHUpdate a schedule
  • DELETERemove a schedule gate
  • POSTActivate or pause a schedule
  • POSTQueue a manual check
  • POSTCreate an immutable report
  • POSTList reports
  • GETGet report details
  • DELETEDelete a report
  • POSTDownload a report
  • POSTGet the API-key scope catalog
  • POSTCreate an API key
  • POSTList API-key metadata
  • GETGet API-key metadata
  • DELETEDelete an API key
  • PATCHUpdate API-key metadata
  • POSTCreate a notification channel
  • POSTList notification channels
  • POSTResolve notification channels by ID
  • GETGet notification channel details
  • DELETEDelete a notification channel
  • PATCHUpdate a notification channel
  • POSTSend a test notification
  • POSTCreate a project worker
  • POSTList project workers
  • GETGet worker details
  • DELETEDelete a worker
  • PATCHUpdate a worker
  • POSTRead live worker agent logs
  • POSTList checks
  • POSTSummarize check statuses
  • GETGet check details
  • POSTGet check log sections
  • POSTDownload a check log
  • POSTDownload check audit evidence
  • POSTList notification messages
  • GETGet notification message details

Checks

Read restore-check status, logs, summaries, and downloadable audit evidence.

Loading documentation…

Schedules< PreviousReportsNext >

Powered by heyo

On this page

Find checksCount checks without paginationRead logs and evidenceThe backup file a check usedEndpoint reference

Checks are run records created by schedules or manual runs. Their status and execution data evolve until finalization; the terminal result is then immutable. API keys have read-only access through v1.checks:read.

Find checks

List filters support:

  • schedule_id or a case-insensitive schedule_name
  • engine
  • worker_id
  • status
  • started_from: manual or scheduled
  • created_at_since: an inclusive ISO 8601 timestamp with an explicit offset or Z; values without one, and date-only values, are rejected with 400

A check's detail also carries planned_run_at, the cron occurrence a scheduled check was dispatched for (null for manual runs), while created_at is the moment the check was created and started_at the moment a worker claimed it.

Count checks without pagination

POST /v1/checks/summary takes project_id and a required top-level created_at_since timestamp:

json
{  "project_id": "65f0c7a9a7d6b4e2c1234567",  "created_at_since": "2026-10-01T00:00:00Z"}

It returns data.created_at_since, data.total, and data.by_status, counting all project checks created at or after that timestamp. It has no pagination or list filters beyond this lower bound. Missing or blank statuses count as unknown; zero-count status buckets are omitted. A summary timeout returns 503.

Statuses are queued, leased, running, success, timeout, failed_infra, failed_configuration, failed_download, failed_restore, failed_probe, failed_quota, and failed_other. See Check results for their meanings.

Read logs and evidence

Use the log endpoint for structured sections or download the merged log as plain text. A log response can report incomplete: true; treat it as a partial view and inspect incomplete_reason.

Audit proof downloads support:

  • json for the canonical check document
  • ots for the binary OpenTimestamps proof, when available
Evidence responses are files

Log and proof downloads return file content with Cache-Control: no-store, not a JSON success envelope.

The backup file a check used

A finished check can record the selected file in result.artifact:

FieldMeaning
filename, keySelected filename and path/key within the source
locationFull address built from the source snapshot, without credentials; can be null if unavailable
size_bytes, sha256Downloaded size and SHA-256 before decryption, decompression, or unpacking
listed_size_bytes, last_modifiedSize and modification time reported by the source listing
completeWhether the download has a recorded checksum; does not mean the restore or check succeeded

After a failed download, size_bytes and sha256 are null and complete is false. A restore failure can still carry complete artifact metadata. The field can be absent when no file was selected, the worker could not report it, or the check predates artifact reporting.

payload.source_endpoint snapshots the source connection at dispatch. It supplies the address even after the source is edited or deleted. Both it and result.artifact, when present, are covered by the canonical JSON audit hash and its OpenTimestamps proof. The artifact checksum and the JSON proof digest are different values.

Endpoint reference

  • List checks
  • Summarize check statuses
  • Get check details
  • Read check log sections
  • Download a check log
  • Download audit evidence

Related topics

  • Trigger a manual check
  • Build an immutable report
  • Inspect check notifications