CloudCasa REST API Reference

The CloudCasa REST API Reference outlines the technical design and typical usage of the Representational State Transfer Application programming interface (REST API) for CloudCasa.

About CloudCasa

CloudCasa by Catalogic Software® is a data protection solution that is built for protecting Kubernetes, cloud databases, and cloud native applications. As a Software-as-a-Service (SaaS) solution, CloudCasa removes the complexity of managing traditional backup infrastructure, while providing the same level of application consistent data protection and disaster recovery that more traditional backup solutions provide for server-based applications.

Contents

• Overview
  • Authentication
  • Concurrency Control
  • Filtering
  • Sorting
  • Pagination
  • Pattern matching
• Kubernetes Clusters
  • Registering a Kubernetes Cluster
  • Create a Cluster resource
  • Getting a cluster resource
  • Listing Clusters
  • Updating Cluster
  • Deleting a cluster resource
• Cloud Accounts
  • Creating a Cloud Account resource
  • Post-registration steps for AWS Accounts
  • Listing Discovered Clusters
  • Installing agent on a discovered Cluster
  • Running Cloud Account Inventory
  • Deleting a Cloud Account
• Configuration
  • Selection of Backup Target
• User Storage
  • List supported providers and regions
  • User Objectstores
  • Creating an S3 compatible user Objectstore
  • List Objectstores
  • Updating user Objectstores
  • Deleting an Objectstore
• Policies
  • Creating a Policy
  • Get/List
  • Updating a Policy
  • Pausing and resuming a Policy
  • Deleting a Policy
• Kubernetes Cluster Snapshot Backups
  • Defining a Scheduled Backup
  • Running a Backup
  • Get/List
  • Pause/Resume
  • Get backups for a cluster
  • Delete a backup
• Kubernetes Cluster Copy Backups
  • Defining a Scheduled Copy
  • Setting preferred backup target
  • Running a copy
  • Cancelling a copy
  • Deleting a copy resource
• Restore
  • Listing available recovery points
  • Listing namespaces in a backup
  • Listing Persistent Volumes in a backup
  • Listing storage classes in backup instance
  • Listing resource types available for restore
  • Listing labels in a backup
  • Defining restore
  • Running a Restore
  • Deleting a restore
• Jobs
  • Reporting PVC progress
  • Cancelling a job