Skip to main content

Create Server Plan Backup Content

API to create backup content on server plan

Path Parameters
  • planId int32 required

    Id of the Plan to modify

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 boolean

    Do you want to back up the system state? Applicable only for Windows

  • backupSystemStateOnlyWithFullBackup boolean

    Default value: false

    Do you want to back up system state only with full backup? Applicable only if the value of backupSystemState is true

  • useVSSForSystemState boolean

    Do you want to back up system state with VSS? Applicable only if the value of backupSystemState is true

  • windowsNumberOfDataReaders object
  • useOptimal boolean

    Set optimal number of data readers. if it is set to true, count will be ignored.

  • count int32

    Possible 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 boolean

    Set optimal number of data readers. if it is set to true, count will be ignored.

  • count int32

    Possible 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 boolean

    Set optimal number of data readers. if it is set to true, count will be ignored.

  • count int32

    Possible values: >= 1

    Number of data readers.

  • forceUpdateProperties boolean

    Do you want to sync properties on associated subclients even if properties are overriden at subclient level?

Responses

Success


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 boolean

    Do you want to back up the system state? Applicable only for Windows

  • backupSystemStateOnlyWithFullBackup boolean

    Default value: false

    Do you want to back up system state only with full backup? Applicable only if the value of backupSystemState is true

  • useVSSForSystemState boolean

    Do you want to back up system state with VSS? Applicable only if the value of backupSystemState is true

  • windowsNumberOfDataReaders object
  • useOptimal boolean

    Set optimal number of data readers. if it is set to true, count will be ignored.

  • count int32

    Possible 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 boolean

    Set optimal number of data readers. if it is set to true, count will be ignored.

  • count int32

    Possible 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 boolean

    Set optimal number of data readers. if it is set to true, count will be ignored.

  • count int32

    Possible values: >= 1

    Number of data readers.

  • forceUpdateProperties boolean

    Do you want to sync properties on associated subclients even if properties are overriden at subclient level?

  • error object
  • errorMessage string
  • errorCode int32
Loading...