Create Backup Destination for Server Plan
Select
SaaS
Customer Managed
Create a Backup Destination for a Plan
Path Parameters
- planId int32 required
Id of the Plan to modify
- application/json
Request Body
destinations object[] required
snapshotOptions object
region object
Responses
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
planBackupDestination object[]
- failedDestinations string[]
List of destinations for which the operation failed
error object
{
"planBackupDestination": [
{
"id": 0,
"name": "string"
}
],
"failedDestinations": [
"string"
],
"error": {
"errorMessage": "string",
"errorCode": 0
}
}
Requested Details not found
POST /v4/serverplan/:planid/backupdestination
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/ServerPlan/:planId/BackupDestination' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"destinations": [
null,
null
],
"snapshotOptions": {
"snapRecoveryPoints": 0,
"retentionPeriodDays": 30,
"enableBackupCopy": true,
"backupCopyRPOMins": 240,
"enableSnapCatalog": true,
"backupCopyOptions": {
"backupTypeToCopy": "All_JOBS",
"backupFullToCopy": "FIRST",
"startTime": 1706110498,
"enableAlert": true,
"alertInHours": 48,
"action": "BASED_ON_RETENTION",
"skipAfterThresholdDays": 14
}
},
"region": {
"id": 0,
"GUID": "string",
"name": "string"
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/ServerPlan/:planId/BackupDestination' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"destinations": [
null,
null
],
"snapshotOptions": {
"snapRecoveryPoints": 0,
"retentionPeriodDays": 30,
"enableBackupCopy": true,
"backupCopyRPOMins": 240,
"enableSnapCatalog": true,
"backupCopyOptions": {
"backupTypeToCopy": "All_JOBS",
"backupFullToCopy": "FIRST",
"startTime": 1706110498,
"enableAlert": true,
"alertInHours": 48,
"action": "BASED_ON_RETENTION",
"skipAfterThresholdDays": 14
}
},
"region": {
"id": 0,
"GUID": "string",
"name": "string"
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/ServerPlan/:planId/BackupDestination' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"destinations": [
null,
null
],
"snapshotOptions": {
"snapRecoveryPoints": 0,
"retentionPeriodDays": 30,
"enableBackupCopy": true,
"backupCopyRPOMins": 240,
"enableSnapCatalog": true,
"backupCopyOptions": {
"backupTypeToCopy": "All_JOBS",
"backupFullToCopy": "FIRST",
"startTime": 1706110498,
"enableAlert": true,
"alertInHours": 48,
"action": "BASED_ON_RETENTION",
"skipAfterThresholdDays": 14
}
},
"region": {
"id": 0,
"GUID": "string",
"name": "string"
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/ServerPlan/:planId/BackupDestination' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"destinations": [
null,
null
],
"snapshotOptions": {
"snapRecoveryPoints": 0,
"retentionPeriodDays": 30,
"enableBackupCopy": true,
"backupCopyRPOMins": 240,
"enableSnapCatalog": true,
"backupCopyOptions": {
"backupTypeToCopy": "All_JOBS",
"backupFullToCopy": "FIRST",
"startTime": 1706110498,
"enableAlert": true,
"alertInHours": 48,
"action": "BASED_ON_RETENTION",
"skipAfterThresholdDays": 14
}
},
"region": {
"id": 0,
"GUID": "string",
"name": "string"
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/ServerPlan/:planId/BackupDestination' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"destinations": [
null,
null
],
"snapshotOptions": {
"snapRecoveryPoints": 0,
"retentionPeriodDays": 30,
"enableBackupCopy": true,
"backupCopyRPOMins": 240,
"enableSnapCatalog": true,
"backupCopyOptions": {
"backupTypeToCopy": "All_JOBS",
"backupFullToCopy": "FIRST",
"startTime": 1706110498,
"enableAlert": true,
"alertInHours": 48,
"action": "BASED_ON_RETENTION",
"skipAfterThresholdDays": 14
}
},
"region": {
"id": 0,
"GUID": "string",
"name": "string"
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/ServerPlan/:planId/BackupDestination' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"destinations": [
null,
null
],
"snapshotOptions": {
"snapRecoveryPoints": 0,
"retentionPeriodDays": 30,
"enableBackupCopy": true,
"backupCopyRPOMins": 240,
"enableSnapCatalog": true,
"backupCopyOptions": {
"backupTypeToCopy": "All_JOBS",
"backupFullToCopy": "FIRST",
"startTime": 1706110498,
"enableAlert": true,
"alertInHours": 48,
"action": "BASED_ON_RETENTION",
"skipAfterThresholdDays": 14
}
},
"region": {
"id": 0,
"GUID": "string",
"name": "string"
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/ServerPlan/:planId/BackupDestination' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"destinations": [
null,
null
],
"snapshotOptions": {
"snapRecoveryPoints": 0,
"retentionPeriodDays": 30,
"enableBackupCopy": true,
"backupCopyRPOMins": 240,
"enableSnapCatalog": true,
"backupCopyOptions": {
"backupTypeToCopy": "All_JOBS",
"backupFullToCopy": "FIRST",
"startTime": 1706110498,
"enableAlert": true,
"alertInHours": 48,
"action": "BASED_ON_RETENTION",
"skipAfterThresholdDays": 14
}
},
"region": {
"id": 0,
"GUID": "string",
"name": "string"
}
}'