GetArchiveBackupDestinations

Get Backup Destinations for a Plan

Path Parameters

planId int32 required
Id of the Archive Plan to retrieve backup destinations

Responses

Success

application/json

Schema
Example (from schema)

Schema

backupdestinations object[]
planBackupDestination object
id int32
name string
isDefault boolean
Is this a default backup destination?
copyType
Possible values: [SYNCHRONOUS, SELECTIVE]
copyTypeName
Possible values: [DEFAULT_MIRROR, DEFAULT_VAULT_REPLICA, MIRROR, VAULT_REPLICA, SNAPSHOT_PRIMARY]
copyPrecedence int32
Order of copy created in storage policy
storagePool object
id int32
Id of Storage Pool
name string
Name of Storage Pool
type
Possible values: [DEDUPLICATION, SECONDARY_COPY, NON_DEDUPLICATION, SCALE_OUT]
Type of Storage Pool
retentionPeriodDays int32
Retention period of pool in days
wormStoragePoolFlag int32
Bit flag indicating WORM configuration of storage pool. 0 means no lock, 1 means compliance lock, 2 means worm storage lock, 4 means Object worm lock and 8 means bucket worm lock.
storageType StorageType
Possible values: [ALL, DISK, CLOUD, HYPERSCALE, TAPE]
sourceCopy object
id int32
name string
region object
id int32
name string
displayName string
enableDataAging boolean
Tells if this copy has data aging enabled
retentionPeriodDays int32
Possible values: >= 1 and <= 9999
Retention period in days
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.
regionsConfigured boolean
Specifies if the plan has region-based storage

{
  "backupdestinations": [
    {
      "planBackupDestination": {
        "id": 0,
        "name": "string"
      },
      "isDefault": true,
      "copyType": "SYNCHRONOUS",
      "copyTypeName": "DEFAULT_MIRROR",
      "copyPrecedence": 0,
      "storagePool": {
        "id": 0,
        "name": "string",
        "type": "DEDUPLICATION",
        "retentionPeriodDays": 0,
        "wormStoragePoolFlag": 0
      },
      "storageType": "ALL",
      "sourceCopy": {
        "id": 0,
        "name": "string"
      },
      "region": {
        "id": 0,
        "name": "string",
        "displayName": "string"
      },
      "enableDataAging": true,
      "retentionPeriodDays": 0,
      "overrideRetentionSettings": true
    }
  ],
  "regionsConfigured": true
}

GetArchiveBackupDestinations​

GetArchiveBackupDestinations