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

application/json

Request Body

• startNewMedia boolean

  Specify whether to start backup on new media

• markMediaFullOnSuccess boolean

  Specify whether to mark media full after completion of backup job

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• taskId int32
• jobIds string[]

  JobIds for the immediate run request

{
  "taskId": 0,
  "jobIds": [
    "string"
  ]
}

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

tokenbearerToken

token

planId — path required

backupDestinationId — path required

includeAllCopies — query

---truefalse

Body

{
  "startNewMedia": true,
  "markMediaFullOnSuccess": true
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/AuxCopy/Run' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "startNewMedia": true,
  "markMediaFullOnSuccess": true
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/AuxCopy/Run' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "startNewMedia": true,
  "markMediaFullOnSuccess": true
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/AuxCopy/Run' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "startNewMedia": true,
  "markMediaFullOnSuccess": true
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/AuxCopy/Run' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "startNewMedia": true,
  "markMediaFullOnSuccess": true
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/AuxCopy/Run' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "startNewMedia": true,
  "markMediaFullOnSuccess": true
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/AuxCopy/Run' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "startNewMedia": true,
  "markMediaFullOnSuccess": true
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Plan/:planId/BackupDestination/:backupDestinationId/AuxCopy/Run' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "startNewMedia": true,
  "markMediaFullOnSuccess": true
}'