ModifyArchiveBackupDestination

Modify Backup Destination for a Plan

Path Parameters

• planId int32 required

  Id of the Plan to modify

• BackupDestinationId int32 required

  Id of the backupDestination to be modified

application/json

Request Body

• newName string

  New name for backup destination

• sourceCopy object

  id int32

  name string
• enableDataAging boolean

  Tells if this copy has data aging enabled

• 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.

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

PUT /v4/archiveplan/:planid/backupdestination/:backupdestinationid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

planId — path required

BackupDestinationId — path required

Body

{
  "newName": "string",
  "sourceCopy": {
    "id": 0,
    "name": "string"
  },
  "enableDataAging": true,
  "retentionPeriodDays": 0,
  "overrideRetentionSettings": true
}

curl -L -X PUT 'https://localhost/webconsole/api/V4/ArchivePlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "sourceCopy": {
    "id": 0,
    "name": "string"
  },
  "enableDataAging": true,
  "retentionPeriodDays": 0,
  "overrideRetentionSettings": true
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/ArchivePlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "sourceCopy": {
    "id": 0,
    "name": "string"
  },
  "enableDataAging": true,
  "retentionPeriodDays": 0,
  "overrideRetentionSettings": true
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/ArchivePlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "sourceCopy": {
    "id": 0,
    "name": "string"
  },
  "enableDataAging": true,
  "retentionPeriodDays": 0,
  "overrideRetentionSettings": true
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/ArchivePlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "sourceCopy": {
    "id": 0,
    "name": "string"
  },
  "enableDataAging": true,
  "retentionPeriodDays": 0,
  "overrideRetentionSettings": true
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/ArchivePlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "sourceCopy": {
    "id": 0,
    "name": "string"
  },
  "enableDataAging": true,
  "retentionPeriodDays": 0,
  "overrideRetentionSettings": true
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/ArchivePlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "sourceCopy": {
    "id": 0,
    "name": "string"
  },
  "enableDataAging": true,
  "retentionPeriodDays": 0,
  "overrideRetentionSettings": true
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/ArchivePlan/:planId/BackupDestination/:BackupDestinationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "sourceCopy": {
    "id": 0,
    "name": "string"
  },
  "enableDataAging": true,
  "retentionPeriodDays": 0,
  "overrideRetentionSettings": true
}'