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

Secrets

Register project-local credential references while keeping secret values out of the RestoreTrust API.

Loading documentation…

Sources< PreviousSchedulesNext >

Powered by heyo

On this page

Service typesLifecycle constraintsEndpoint reference

A RestoreTrust secret is metadata that points to a secret already present in the worker's Kubernetes environment. The API stores the reference, not the credential value.

Never send credential values

Create the Kubernetes Secret in the worker environment first. Send only its local_secret_name to RestoreTrust.

Service types

Use s3, ftp, sftp, or smb for source credentials. Schedules can also reference:

  • archive_password for a password-protected ZIP backup
  • age_identity for age identity-file decryption
  • age_passphrase for age passphrase decryption

local_secret_name must be a valid lowercase Kubernetes object name and cannot refer to the worker identity secret.

Lifecycle constraints

Secret values are never returned. You can update name, description, local_secret_name, or set status to active or paused. The service type is immutable.

A secret cannot be paused or deleted while a source or schedule references it. List filters support name, service_type, and status.

Endpoint reference

  • Create secret metadata
  • List secrets
  • Get secret metadata
  • Update secret metadata
  • Delete secret metadata

Required scopes are v1.secrets:read, v1.secrets:write, and v1.secrets:delete.

Related topics

  • Link a secret to a source
  • Configure encrypted backups
  • Protect API credentials