Skip to main content

Create backup destination (without Plan)

Select

SaaS
Customer Managed

Create backup destination(s) for a plan before creating the plan. The primary backup destination can be then associated with the plan to associate all secondary copies also.

Request Body
  • backupDestinations object[] required

    List of backup destinations to create

  • name string required

    Name of backup destination

  • storagePool object required
  • id int32
  • name string
  • storageType StorageType

    Possible values: [ALL, DISK, CLOUD, HYPERSCALE, TAPE]

  • netAppCloudTarget boolean

    Only for snap copy. Enabling this changes SVM Mapping to NetApp cloud targets only.

  • isSnapCopy boolean

    Is this a snap copy? If isMirrorCopy is not set, then default is Vault/Replica.

  • isMirrorCopy boolean

    Is this a mirror copy? Only considered when isSnapCopy is true.

  • region object
  • id int32
  • name string
  • sourceCopy object
  • id int32
  • name string
  • backupsToCopy string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

  • fullBackupTypesToCopy PlanFullBackupTypeToCopy

    Possible values: [FIRST, LAST]

    Which type of backup type should be copied for the given backup destination when backup type is not all jobs. Default is LAST while adding new backup destination.

  • backupStartTime int32

    Backup start time in seconds. The time is provided in unix time format.

  • optimizeForInstantClone boolean

    Flag to specify if primary storage is copy data management enabled.

  • overrideRetentionSettings boolean

    Tells if this copy should use storage pool retention period days or the retention defined for this copy. Set as true to use retention defined on this copy.

  • retentionRuleType RententionRuleTypes

    Possible values: [RETENTION_PERIOD, SNAP_RECOVERY_POINTS]

    Which type of retention rule should be used for the given backup destination

  • retentionPeriodDays int32

    Possible values: >= 1 and <= 9999

    Default value: 30

    Retention period in days. -1 can be specified for infinite retention. If this and snapRecoveryPoints both are not specified, this takes precedence.

  • snapRecoveryPoints int32

    Possible values: >= 1

    Number of snap recovery points for snap copy for retention. Can be specified instead of retention period in Days for snap copy.

  • useExtendedRetentionRules boolean

    Use extended retention rules

  • extendedRetentionRules object

    If you want to update, specify the whole object. Extended retention rules should be bigger than retention period.

  • firstExtendedRetentionRule object
  • isInfiniteRetention boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

  • secondExtendedRetentionRule object
  • isInfiniteRetention boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

  • thirdExtendedRetentionRule object
  • isInfiniteRetention boolean

    If this is set as true, no need to specify retentionPeriodDays.

  • retentionPeriodDays int32

    If this is set, no need to specify isInfiniteRetention as false.

  • type string

    Possible values: [All_JOBS, ALL_FULLS, HOURLY_FULLS, DAILY_FULLS, WEEKLY_FULLS, MONTHLY_FULLS, QUARTERLY_FULLS, HALF_YEARLY_FULLS, YEARLY_FULLS, ADVANCED]

    All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only.

  • mappings object[]
  • vendor

    Possible values: [NETAPP, AMAZON, PURE, AZURE]

    Snapshot vendors available for Snap Copy mappings

  • source object
  • id int32
  • name string
  • target object
  • id int32
  • name string
  • sourceVendor object
  • id int32
  • name string
  • targetVendor object
  • id int32
  • name string
Responses

Success


Schema
  • planBackupDestination object[]

    List of destinations effected or created

  • id int32

    Id of the backup destination affected or created

  • name string

    Name of the backup destination affected or created

  • isDefault boolean

    Tells if this is the default (primary) backup destination

  • failedDestinations string[]

    List of destinations for which the operation failed

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