Operations API

Overview

The Cloudback Operations API allows users to manage backup definitions programmatically. It provides a RESTful interface to update backup definitions for repositories.

Features

• Automated backup definition configuration for repositories

• Programmatic management of backup configurations

Prerequisites

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 API Keys page in the Cloudback dashboard.

• Network Access: Ensure that your environment can reach Cloudback’s endpoints: https://app.cloudback.it/api/ops/

API Reference

Get Backup Definition

Get Request

POST https://app.cloudback.it/api/ops/definition/get
Content-Type: application/json
X-API-Key: your-api-key
{
  "platform": "GitHub",
  "account": "cloudback",
  "repository": "demo-repository"
}

Get Response

HTTP/1.1 200 OK
{
  "platform": "GitHub",
  "account": "cloudback",
  "repository": "demo-repository",
  "settings": {
    "enabled": true,
    "schedule": "Daily at 9 pm",
    "storage": "Cloudback EU",
    "retention": "Last 30 days"
  }
}

Update Backup Definition

Update Request

POST https://app.cloudback.it/api/ops/definition/update
Content-Type: application/json
X-API-Key: your-api-key
{
  "platform": "GitHub",
  "account": "cloudback",
  "repository": "demo-repository",
  "settings": {
    "enabled": true,
    "schedule": "Daily at 9 pm",
    "storage": "Cloudback EU",
    "retention": "Last 30 days"
  }
}

Update Response

HTTP/1.1 200 OK
{
  "platform": "GitHub",
  "account": "cloudback",
  "repository": "demo-repository",
  "settings": {
    "enabled": true,
    "schedule": "Daily at 9 pm",
    "storage": "Cloudback EU",
    "retention": "Last 30 days"
  }
}

Data Model

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.

  • schedule: The schedule for the automated backup. Complete list of supported schedules can be found here. Optional.

  • storage: The storage location for the backup. Complete list of supported storages can be found here. Optional.

  • retention: The retention policy for the backup. Possible options are Last 30 days, Last 90 days, Last 180 days, Last 360 days. Optional.

References

• Terraform Provider