CreateArchiveBackupDestination

Create a Backup Destination for a Plan

Path Parameters

• planId int32 required

  Id of the Plan to modify

application/json

Request Body

• destinations object[] required

  List of backup destinations to create

  backupDestinationName string required

  Backup destination details. Enter the name during creation.

  storagePool object required

  id int32

  name string

  region object

  id int32

  name string

  sourceCopy object

  id int32

  name string

  retentionPeriodDays int32

  Possible values: >= 1 and <= 9999

  Retention period in days. -1 can be specified for infinite retention.

  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.

• region object

  id int32

  name string

Responses

• 200
• 404

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• planBackupDestination object[]

  List of destinations effected or created

  id int32

  name string
• failedDestinations string[]

  List of destinations for which the operation failed

• error object

  errorMessage string

  errorCode int32

{
  "planBackupDestination": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "failedDestinations": [
    "string"
  ],
  "error": {
    "errorMessage": "string",
    "errorCode": 0
  }
}

Requested Details not found

POST /v4/archiveplan/:planid/backupdestination    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

planId — path required

Body

{
  "destinations": [
    {
      "backupDestinationName": "string",
      "storagePool": {
        "id": 0,
        "name": "string"
      },
      "region": {
        "id": 0,
        "name": "string"
      },
      "sourceCopy": {
        "id": 0,
        "name": "string"
      },
      "retentionPeriodDays": 0,
      "overrideRetentionSettings": true
    }
  ],
  "region": {
    "id": 0,
    "name": "string"
  }
}

curl -L -X POST 'https://localhost/webconsole/api/V4/ArchivePlan/:planId/BackupDestination' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "destinations": [
    {
      "backupDestinationName": "string",
      "storagePool": {
        "id": 0,
        "name": "string"
      },
      "region": {
        "id": 0,
        "name": "string"
      },
      "sourceCopy": {
        "id": 0,
        "name": "string"
      },
      "retentionPeriodDays": 0,
      "overrideRetentionSettings": true
    }
  ],
  "region": {
    "id": 0,
    "name": "string"
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/ArchivePlan/:planId/BackupDestination' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "destinations": [
    {
      "backupDestinationName": "string",
      "storagePool": {
        "id": 0,
        "name": "string"
      },
      "region": {
        "id": 0,
        "name": "string"
      },
      "sourceCopy": {
        "id": 0,
        "name": "string"
      },
      "retentionPeriodDays": 0,
      "overrideRetentionSettings": true
    }
  ],
  "region": {
    "id": 0,
    "name": "string"
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/ArchivePlan/:planId/BackupDestination' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "destinations": [
    {
      "backupDestinationName": "string",
      "storagePool": {
        "id": 0,
        "name": "string"
      },
      "region": {
        "id": 0,
        "name": "string"
      },
      "sourceCopy": {
        "id": 0,
        "name": "string"
      },
      "retentionPeriodDays": 0,
      "overrideRetentionSettings": true
    }
  ],
  "region": {
    "id": 0,
    "name": "string"
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/ArchivePlan/:planId/BackupDestination' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "destinations": [
    {
      "backupDestinationName": "string",
      "storagePool": {
        "id": 0,
        "name": "string"
      },
      "region": {
        "id": 0,
        "name": "string"
      },
      "sourceCopy": {
        "id": 0,
        "name": "string"
      },
      "retentionPeriodDays": 0,
      "overrideRetentionSettings": true
    }
  ],
  "region": {
    "id": 0,
    "name": "string"
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/ArchivePlan/:planId/BackupDestination' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "destinations": [
    {
      "backupDestinationName": "string",
      "storagePool": {
        "id": 0,
        "name": "string"
      },
      "region": {
        "id": 0,
        "name": "string"
      },
      "sourceCopy": {
        "id": 0,
        "name": "string"
      },
      "retentionPeriodDays": 0,
      "overrideRetentionSettings": true
    }
  ],
  "region": {
    "id": 0,
    "name": "string"
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/ArchivePlan/:planId/BackupDestination' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "destinations": [
    {
      "backupDestinationName": "string",
      "storagePool": {
        "id": 0,
        "name": "string"
      },
      "region": {
        "id": 0,
        "name": "string"
      },
      "sourceCopy": {
        "id": 0,
        "name": "string"
      },
      "retentionPeriodDays": 0,
      "overrideRetentionSettings": true
    }
  ],
  "region": {
    "id": 0,
    "name": "string"
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/V4/ArchivePlan/:planId/BackupDestination' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "destinations": [
    {
      "backupDestinationName": "string",
      "storagePool": {
        "id": 0,
        "name": "string"
      },
      "region": {
        "id": 0,
        "name": "string"
      },
      "sourceCopy": {
        "id": 0,
        "name": "string"
      },
      "retentionPeriodDays": 0,
      "overrideRetentionSettings": true
    }
  ],
  "region": {
    "id": 0,
    "name": "string"
  }
}'