Checks
Read restore-check status, logs, summaries, and downloadable audit evidence.
Loading documentation…
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.
List filters support:
schedule_id or a case-insensitive schedule_nameengineworker_idstatusstarted_from: manual or scheduledcreated_at_since: an inclusive ISO 8601 timestamp with an explicit offset or Z; values without one, and date-only values, are rejected with 400A 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.
POST /v1/checks/summary takes project_id and a required top-level created_at_since timestamp:
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.
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 documentots for the binary OpenTimestamps proof, when availableLog and proof downloads return file content with Cache-Control: no-store, not
a JSON success envelope.
A finished check can record the selected file in result.artifact:
| Field | Meaning |
|---|---|
filename, key | Selected filename and path/key within the source |
location | Full address built from the source snapshot, without credentials; can be null if unavailable |
size_bytes, sha256 | Downloaded size and SHA-256 before decryption, decompression, or unpacking |
listed_size_bytes, last_modified | Size and modification time reported by the source listing |
complete | Whether 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.