API resources
Choose the RestoreTrust resources and generated endpoint references needed for your automation.
Loading documentation…
RestoreTrust API resources fall into an automation surface and a smaller set of interactive-session workflows.
| Resource | Typical use |
|---|---|
| Secrets | Register safe references to credentials held in your worker environment. |
| Sources | Describe the backup location a worker can access. |
| Workers | Provision and inspect project workers. |
| Schedules | Define recurring restore tests and trigger manual checks. |
| Checks | Read run status, logs, and audit evidence. |
| Reports | Generate and download immutable result reports. |
| Notification channels | Configure email or webhook delivery targets. |
| Messages | Inspect notification delivery outcomes. |
| API keys | Read or update key metadata when explicitly scoped. |
Create a secret reference, source, worker, notification channel, and schedule. Then trigger a manual run and read the resulting check.
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.
The generated pages contain methods, paths, scopes, request schemas, response schemas, status codes, and examples. Start with: