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

Sources

Register project backup locations without sending credential values to the RestoreTrust API.

Loading documentation…

Projects< PreviousSecretsNext >

Powered by heyo

On this page

Create a sourceLifecycle constraintsEndpoint reference

A source describes where a project worker can find backups. It references secret metadata from the same project; credential values are not sent to this API.

TLS validation is enforced

Source-specific certificate bypasses are not supported. Use a valid certificate for HTTPS endpoints.

Create a source

Send project_id, name, service_type, protocol, domain, port, and secret_id. Supported source types are s3, ftp, sftp, and smb.

  • S3 uses http or https and also requires region, bucket, and s3_addressing_style.
  • FTP uses ftp.
  • SFTP uses sftp.
  • SMB uses smb and requires the share name in bucket.

The referenced secret must be active, belong to the same project, and have the matching service type.

Lifecycle constraints

You can update connection metadata, the linked secret, or status. A source referenced by a schedule cannot be paused or deleted. Source type is immutable; create a replacement source when the type changes.

List filters support name, endpoint, kind, and status.

Endpoint reference

  • Create a source
  • List sources
  • Get source details
  • Update a source
  • Delete a source

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

Related topics

  • Register secret metadata first
  • Use a source in a schedule
  • Understand project ownership