Skip to main content

Run aux copy for backup destination(s) of a plan​

Select

SaaS
Customer Managed

Run aux copy job for backup destination(s) of a plan.

Path Parameters
  • planId int32 required

    Id of the Plan

  • backupDestinationId int32 required

    Id of Backup Destination.

Query Parameters
  • includeAllCopies boolean

    Primary backupDestinationId can be passed in backupDestinationId Path param when includeAllCopies is set to true, this will trigger the aux copy on all supported backup destinations of a region

Responses

OK

Schema
  • taskId int32
  • jobIds string[]

    JobIds for the immediate run request

POST /v4/plan/:planid/backupdestination/:backupdestinationid/auxcopy/run

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
planId — path required
backupDestinationId — path required
includeAllCopies — query
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/AuxCopy/Run' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'