API overview

Automate project-scoped RestoreTrust resources with the versioned REST API.

Use the RestoreTrust REST API to manage restore-test configuration, start checks, and retrieve results and evidence for one project.

Versioned base path

Append /v1 to the API origin for your RestoreTrust deployment. The examples use https://api.restoretrust.example/v1, a deliberately non-routable example host.

What you can automate

Project-scoped API keys can access the resources allowed by their scopes:

sources, secrets, and schedules
checks, check logs, and audit proof downloads
reports
notification channels and delivery messages
workers
API-key metadata, when the calling key has the required API-key scopes

Project, organization, onboarding, and API-key creation operations require an interactive console session. They are not available to API keys.

API conventions

AuthenticationX-API-Keyoptional

Send a project-scoped API key in every automation request.

Content typeapplication/jsonoptional

Send JSON for request bodies unless an endpoint documents a file response.

Project scopeObjectIdoptional

Create and list operations take project_id; item operations derive it from the item.

Success envelopeobjectoptional

JSON responses use {"status":"success","data":...}. Lists also return cursor metadata.

Error envelopeobjectoptional

Errors use {"status":"error","message":"..."} and may include a stable code or structured details.

Start here

Follow the API quickstart to create a scoped key and list checks. The generated endpoint reference contains the exact request and response schema for each operation.

API essentials

Loading documentation…