Operations API
Last updated
Was this helpful?
Last updated
Was this helpful?
The Cloudback Operations API allows users to manage backup definitions programmatically. It provides a RESTful interface to update backup definitions for repositories.
Automated backup definition configuration for repositories
Programmatic management of backup configurations
Before you begin, ensure that you have the following:
Terraform Installed: Version 1.0 or later is recommended.
Cloudback Account: An active account with appropriate permissions to create and manage backup resources.
API Key: Your API key for Cloudback’s API. You can create one at the page in the Cloudback dashboard.
Network Access: Ensure that your environment can reach Cloudback’s endpoints: https://app.cloudback.it/api/ops/
Attributes:
platform: The platform of the repository (e.g., GitHub, GitLab, Bitbucket). Mandatory.
account: The account name of the repository. Mandatory.
repository: The repository name. Mandatory.
settings: The backup configuration settings. Mandatory.
enabled: Whether the automated scheduled backup is enabled, true or false. Optional.
retention: The retention policy for the backup. Possible options are Last 30 days, Last 90 days, Last 180 days, Last 360 days. Optional.
schedule: The schedule for the automated backup. Complete list of supported schedules can be found . Optional.
storage: The storage location for the backup. Complete list of supported storages can be found . Optional.