Update Backup Destination details of ServerPlan
Modify Backup Destination details for a Plan
Path Parameters
- planId int32 required
Id of the Plan to modify
- BackupDestinationId int32 required
Id of the backupDestination to be modified
- application/json
Request Body
- newName string
New name for backup destination
general object
backupType object
retentionRules object
mappings 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
PUT /v5/serverplan/:planid/backupdestination/:backupdestinationid
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X PUT 'https://localhost/webconsole/api/V5/ServerPlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"general": {
"source": {
"id": 0,
"name": "string"
},
"isActive": true
},
"backupType": {
"backupTypesToCopy": "All_JOBS",
"backupTypesCopiedFrom": 0,
"fullBackupTypesToCopy": "FIRST"
},
"retentionRules": {
"enableDataAging": true,
"overrideRetentionSettings": true,
"retentionRuleType": "RETENTION_PERIOD",
"retentionPeriodDays": 0,
"snapRecoveryPoints": 0,
"useExtendedRetentionRules": true,
"extendedRetentionRules": {
"firstExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"secondExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"thirdExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
}
},
"fullBackupTypesToBeRetained": "FIRST"
},
"mappings": [
{
"vendor": "NETAPP",
"source": {
"id": 0,
"name": "string"
},
"target": {
"id": 0,
"name": "string"
},
"sourceVendor": {
"id": 0,
"name": "string"
},
"targetVendor": {
"id": 0,
"name": "string"
}
}
]
}'
curl -L -X PUT 'https://localhost/webconsole/api/V5/ServerPlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"general": {
"source": {
"id": 0,
"name": "string"
},
"isActive": true
},
"backupType": {
"backupTypesToCopy": "All_JOBS",
"backupTypesCopiedFrom": 0,
"fullBackupTypesToCopy": "FIRST"
},
"retentionRules": {
"enableDataAging": true,
"overrideRetentionSettings": true,
"retentionRuleType": "RETENTION_PERIOD",
"retentionPeriodDays": 0,
"snapRecoveryPoints": 0,
"useExtendedRetentionRules": true,
"extendedRetentionRules": {
"firstExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"secondExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"thirdExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
}
},
"fullBackupTypesToBeRetained": "FIRST"
},
"mappings": [
{
"vendor": "NETAPP",
"source": {
"id": 0,
"name": "string"
},
"target": {
"id": 0,
"name": "string"
},
"sourceVendor": {
"id": 0,
"name": "string"
},
"targetVendor": {
"id": 0,
"name": "string"
}
}
]
}'
curl -L -X PUT 'https://localhost/webconsole/api/V5/ServerPlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"general": {
"source": {
"id": 0,
"name": "string"
},
"isActive": true
},
"backupType": {
"backupTypesToCopy": "All_JOBS",
"backupTypesCopiedFrom": 0,
"fullBackupTypesToCopy": "FIRST"
},
"retentionRules": {
"enableDataAging": true,
"overrideRetentionSettings": true,
"retentionRuleType": "RETENTION_PERIOD",
"retentionPeriodDays": 0,
"snapRecoveryPoints": 0,
"useExtendedRetentionRules": true,
"extendedRetentionRules": {
"firstExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"secondExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"thirdExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
}
},
"fullBackupTypesToBeRetained": "FIRST"
},
"mappings": [
{
"vendor": "NETAPP",
"source": {
"id": 0,
"name": "string"
},
"target": {
"id": 0,
"name": "string"
},
"sourceVendor": {
"id": 0,
"name": "string"
},
"targetVendor": {
"id": 0,
"name": "string"
}
}
]
}'
curl -L -X PUT 'https://localhost/webconsole/api/V5/ServerPlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"general": {
"source": {
"id": 0,
"name": "string"
},
"isActive": true
},
"backupType": {
"backupTypesToCopy": "All_JOBS",
"backupTypesCopiedFrom": 0,
"fullBackupTypesToCopy": "FIRST"
},
"retentionRules": {
"enableDataAging": true,
"overrideRetentionSettings": true,
"retentionRuleType": "RETENTION_PERIOD",
"retentionPeriodDays": 0,
"snapRecoveryPoints": 0,
"useExtendedRetentionRules": true,
"extendedRetentionRules": {
"firstExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"secondExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"thirdExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
}
},
"fullBackupTypesToBeRetained": "FIRST"
},
"mappings": [
{
"vendor": "NETAPP",
"source": {
"id": 0,
"name": "string"
},
"target": {
"id": 0,
"name": "string"
},
"sourceVendor": {
"id": 0,
"name": "string"
},
"targetVendor": {
"id": 0,
"name": "string"
}
}
]
}'
curl -L -X PUT 'https://localhost/webconsole/api/V5/ServerPlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"general": {
"source": {
"id": 0,
"name": "string"
},
"isActive": true
},
"backupType": {
"backupTypesToCopy": "All_JOBS",
"backupTypesCopiedFrom": 0,
"fullBackupTypesToCopy": "FIRST"
},
"retentionRules": {
"enableDataAging": true,
"overrideRetentionSettings": true,
"retentionRuleType": "RETENTION_PERIOD",
"retentionPeriodDays": 0,
"snapRecoveryPoints": 0,
"useExtendedRetentionRules": true,
"extendedRetentionRules": {
"firstExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"secondExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"thirdExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
}
},
"fullBackupTypesToBeRetained": "FIRST"
},
"mappings": [
{
"vendor": "NETAPP",
"source": {
"id": 0,
"name": "string"
},
"target": {
"id": 0,
"name": "string"
},
"sourceVendor": {
"id": 0,
"name": "string"
},
"targetVendor": {
"id": 0,
"name": "string"
}
}
]
}'
curl -L -X PUT 'https://localhost/webconsole/api/V5/ServerPlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"general": {
"source": {
"id": 0,
"name": "string"
},
"isActive": true
},
"backupType": {
"backupTypesToCopy": "All_JOBS",
"backupTypesCopiedFrom": 0,
"fullBackupTypesToCopy": "FIRST"
},
"retentionRules": {
"enableDataAging": true,
"overrideRetentionSettings": true,
"retentionRuleType": "RETENTION_PERIOD",
"retentionPeriodDays": 0,
"snapRecoveryPoints": 0,
"useExtendedRetentionRules": true,
"extendedRetentionRules": {
"firstExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"secondExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"thirdExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
}
},
"fullBackupTypesToBeRetained": "FIRST"
},
"mappings": [
{
"vendor": "NETAPP",
"source": {
"id": 0,
"name": "string"
},
"target": {
"id": 0,
"name": "string"
},
"sourceVendor": {
"id": 0,
"name": "string"
},
"targetVendor": {
"id": 0,
"name": "string"
}
}
]
}'
curl -L -X PUT 'https://localhost/webconsole/api/V5/ServerPlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"newName": "string",
"general": {
"source": {
"id": 0,
"name": "string"
},
"isActive": true
},
"backupType": {
"backupTypesToCopy": "All_JOBS",
"backupTypesCopiedFrom": 0,
"fullBackupTypesToCopy": "FIRST"
},
"retentionRules": {
"enableDataAging": true,
"overrideRetentionSettings": true,
"retentionRuleType": "RETENTION_PERIOD",
"retentionPeriodDays": 0,
"snapRecoveryPoints": 0,
"useExtendedRetentionRules": true,
"extendedRetentionRules": {
"firstExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"secondExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
},
"thirdExtendedRetentionRule": {
"isInfiniteRetention": true,
"retentionPeriodDays": 0,
"type": "All_JOBS"
}
},
"fullBackupTypesToBeRetained": "FIRST"
},
"mappings": [
{
"vendor": "NETAPP",
"source": {
"id": 0,
"name": "string"
},
"target": {
"id": 0,
"name": "string"
},
"sourceVendor": {
"id": 0,
"name": "string"
},
"targetVendor": {
"id": 0,
"name": "string"
}
}
]
}'