1. API Reference
  2. API resources
  3. API resources
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

API resources

Choose the RestoreTrust resources and generated endpoint references needed for your automation.

Loading documentation…

Errors< PreviousProjectsNext >

Powered by heyo

On this page

Project automationInteractive-session resourcesGenerated endpoint reference

RestoreTrust API resources fall into an automation surface and a smaller set of interactive-session workflows.

Project automation

ResourceTypical use
SecretsRegister safe references to credentials held in your worker environment.
SourcesDescribe the backup location a worker can access.
WorkersProvision and inspect project workers.
SchedulesDefine recurring restore tests and trigger manual checks.
ChecksRead run status, logs, and audit evidence.
ReportsGenerate and download immutable result reports.
Notification channelsConfigure email or webhook delivery targets.
MessagesInspect notification delivery outcomes.
API keysRead or update key metadata when explicitly scoped.
A common setup order

Create a secret reference, source, worker, notification channel, and schedule. Then trigger a manual run and read the resulting check.

Interactive-session resources

Projects and API-key creation require a signed-in console session. API keys cannot call these operations. They are included to explain provisioning boundaries, not as unattended automation examples. Manage organizations and initial account setup in the console; see Organizations and projects.

Generated endpoint reference

The generated pages contain methods, paths, scopes, request schemas, response schemas, status codes, and examples. Start with:

  • List checks
  • Create a schedule
  • Create a source
  • Create secret metadata
  • Create a worker

Related topics

  • Make your first request
  • Choose least-privilege scopes
  • Paginate resource lists