Cloudback Docs
HomePricingBlogContactSign In
  • Getting Started
    • What is Cloudback?
    • Installation Guide
    • First Backup Walkthrough
  • Managing Backups
    • Automated Daily Backups
    • Metadata Backups
    • One-Click Manual Backups
    • Setting Backup Schedules
    • Manage Backup Storage
    • Backup Retention Policy
    • Password-Protected Backups
    • Account Settings
    • Bulk Operations
    • Data Deduplication
    • Email Notifications
    • Instant Notifications
    • Archive Name Pattern
  • Data Restoration
    • Download Backups
    • Restore to GitHub
  • Automation
    • Terraform Provider
    • Operations API
  • Dashboard
    • Dashboard Overview
    • Card view
    • Table view
    • Repository Details
    • Backup Details and Metadata
    • Backup Status Badge
  • Storage Configuration
    • Cloudback Managed Storages
    • Customer Managed Storages
    • Replicating Backups
  • Supported Storages
    • Alibaba Cloud Object Storage Service
    • Amazon S3 Bucket via Access Key
    • Amazon S3 Bucket via Access Point
    • Amazon S3 Glacier
    • Amazon S3 Object Tagging
    • Google Cloud Storage Bucket
    • Microsoft Azure Blob Container
    • Microsoft OneDrive Business
    • Microsoft OneDrive Personal
    • OpenStack Swift
    • Wasabi Customer Managed Storage
  • Account and Billing Management
    • Payment Methods
    • GitHub Organizations
    • Invoiced Customers
  • Troubleshooting and Support
    • Known Issues
    • Contact us
  • Security Features
    • Access Review: Vanta Integration
    • Immutability: Amazon S3 Object Lock
    • Encryption: Password-Protected Archives
    • Traceability: Audit Log
  • Legal
    • Terms of Service
    • Privacy Policy
Powered by GitBook
LogoLogo

Learn more

  • Integrations
  • Blog

Explore

  • Roadmap
  • Changelog

Support

  • Contact Us
  • Status

Legal

  • Terms of Service
  • Privacy Policy

© 2025 Cloudback

On this page
  • Overview
  • Features
  • Prerequisites
  • API Reference
  • Get Backup Definition
  • Update Backup Definition
  • Data Model
  • References

Was this helpful?

  1. Automation

Operations API

Learn how to manage Cloudback backup definitions programmatically using the Operations API for automated backup configuration.

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

PreviousTerraform ProviderNextDashboard

Last updated 6 days ago

Was this helpful?