Create Server Plan Backup Content
Select
API to create backup content on server plan
Path Parameters
- planId int32 required
Id of the Plan to modify
- application/json
Request Body
backupContent object
This feature applies only to file system agents
windowsIncludedPaths string[]Paths to include for Windows
windowsExcludedPaths string[]Paths to exclude for Windows
windowsFilterToExcludePaths string[]Paths that are exception to excluded paths for Windows
backupSystemState booleanDo you want to back up the system state? Applicable only for Windows
backupSystemStateOnlyWithFullBackup booleanDefault value:
false
Do you want to back up system state only with full backup? Applicable only if the value of backupSystemState is true
useVSSForSystemState booleanDo you want to back up system state with VSS? Applicable only if the value of backupSystemState is true
windowsNumberOfDataReaders object
useOptimal booleanSet optimal number of data readers. if it is set to true, count will be ignored.
count int32Possible values:
>= 1
Number of data readers.
macIncludedPaths string[]Paths to include for Mac
macExcludedPaths string[]Paths to exclude for Mac
macFilterToExcludePaths string[]Paths that are exception to excluded paths for Mac
unixNumberOfDataReaders object
useOptimal booleanSet optimal number of data readers. if it is set to true, count will be ignored.
count int32Possible values:
>= 1
Number of data readers.
unixIncludedPaths string[]Paths to include for UNIX
unixExcludedPaths string[]Paths to exclude for UNIX
unixFilterToExcludePaths string[]Paths that are exception to excluded paths for Unix
macNumberOfDataReaders object
useOptimal booleanSet optimal number of data readers. if it is set to true, count will be ignored.
count int32Possible values:
>= 1
Number of data readers.
forceUpdateProperties booleanDo you want to sync properties on associated subclients even if properties are overriden at subclient level?
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
backupContent object
This feature applies only to file system agents
windowsIncludedPaths string[]Paths to include for Windows
windowsExcludedPaths string[]Paths to exclude for Windows
windowsFilterToExcludePaths string[]Paths that are exception to excluded paths for Windows
backupSystemState booleanDo you want to back up the system state? Applicable only for Windows
backupSystemStateOnlyWithFullBackup booleanDefault value:
false
Do you want to back up system state only with full backup? Applicable only if the value of backupSystemState is true
useVSSForSystemState booleanDo you want to back up system state with VSS? Applicable only if the value of backupSystemState is true
windowsNumberOfDataReaders object
useOptimal booleanSet optimal number of data readers. if it is set to true, count will be ignored.
count int32Possible values:
>= 1
Number of data readers.
macIncludedPaths string[]Paths to include for Mac
macExcludedPaths string[]Paths to exclude for Mac
macFilterToExcludePaths string[]Paths that are exception to excluded paths for Mac
unixNumberOfDataReaders object
useOptimal booleanSet optimal number of data readers. if it is set to true, count will be ignored.
count int32Possible values:
>= 1
Number of data readers.
unixIncludedPaths string[]Paths to include for UNIX
unixExcludedPaths string[]Paths to exclude for UNIX
unixFilterToExcludePaths string[]Paths that are exception to excluded paths for Unix
macNumberOfDataReaders object
useOptimal booleanSet optimal number of data readers. if it is set to true, count will be ignored.
count int32Possible values:
>= 1
Number of data readers.
forceUpdateProperties booleanDo you want to sync properties on associated subclients even if properties are overriden at subclient level?
error object
errorMessage stringerrorCode int32
{
"backupContent": {
"windowsIncludedPaths": [
"string"
],
"windowsExcludedPaths": [
"string"
],
"windowsFilterToExcludePaths": [
"string"
],
"backupSystemState": true,
"backupSystemStateOnlyWithFullBackup": false,
"useVSSForSystemState": true,
"windowsNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"macIncludedPaths": [
"string"
],
"macExcludedPaths": [
"string"
],
"macFilterToExcludePaths": [
"string"
],
"unixNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"unixIncludedPaths": [
"string"
],
"unixExcludedPaths": [
"string"
],
"unixFilterToExcludePaths": [
"string"
],
"macNumberOfDataReaders": {
"useOptimal": true,
"count": 0
},
"forceUpdateProperties": true
},
"error": {
"errorMessage": "string",
"errorCode": 0
}
}
Requested Details not found