Performing Ad-Hoc Backups for Object Storage


To perform ad-hoc backups, you need a content group that has the base content configured to run a full backup on it. The subsequent incremental backups on the content group can be triggered as ad-hoc backups by using REST APIs.

Before You Begin

  • To perform ad-hoc backups from the command line, you need a REST API file (run_ad_hoc_backup_object_storage.xml) which contains the parameter values for configuring the backup options.

  • You must create the following text file to specify where the content is located for ad-hoc backup jobs:

    • A directive file, which is a text file that defines the location of the data that you want to back up. The directive file must be available in the same cloud storage account on which backups will be run because the same authentication used for creating the source object storage will be used in accessing the directive file, reading its contents, and perform the backups.

    • Following is the format for entries in the directive file:

      • The entries in the file must contain UNIX-style path.

        For example:



      • The entries in the file must be separated by a new line.

        Only UNIX-style new line character '\n' is supported.

        On Windows, the new line character '\r' is supported.

        If you are creating the file on Windows by using Notepad++ application, select Unix (LF) for line ending conversion.

      • To differentiate files from folders, add a trailing '/' character for folders.


  1. Disable schedule for the content group.

    When you disable schedule for the content group, the scheduled incrementals are not triggered. Instead, an ad-hoc based incremental will be triggered via REST API on demand by the end user.

  2. Run API based ad-hoc backups.

Commvault Back Page

©1999-2023 Commvault Systems, Inc. All rights reserved. Commvault, Commvault and logo, the "C hexagon” logo, Commvault Systems, Commvault HyperScale, ScaleProtect, Commvault OnePass, Unified Data Management, Quick Recovery, QR, CommNet, GridStor, Vault Tracker, InnerVault, Quick Snap, QSnap, IntelliSnap, Recovery Director, CommServe, CommCell, APSS, Commvault Edge, Commvault GO, Commvault Advantage, Commvault Complete, Commvault Activate, Commvault Orchestrate, Commvault Command Center, Hedvig, Universal Data Plane, the “Cube” logo, Metallic, the “M Wave” logo, and CommValue are trademarks or registered trademarks of Commvault Systems, Inc. All other third party brands, products, service names, trademarks, or registered service marks are the property of and used to identify the products or services of their respective owners. All specification are subject to change without notice.

The development release and timing of future product releases remains at Commvault’s sole discretion. Commvault is providing the following information in accordance with Commvault's standard product communication policies. Any resulting features, functionality, and enhancements or timing of release of such features, functionality, and enhancements are at the sole discretion of Commvault and may be modified without notice. All product roadmap or other similar information does not represent a commitment to deliver any material, code, or functionality, and should not be relied upon in making a purchasing decision.