Skip to main content

Update Backup Location properties​

Modify the properties of an existing mount path

Path Parameters
  • storagePoolId int32 required

    Id of the disk storage to update

  • backupLocationId int32 required

    Id of the backup location to update

Request Body
  • mediaAgent object required
  • id int32
  • name string
  • access string

    Possible values: [READ_AND_WRITE, READ]

    The access type for the access path can be either read (writing to path not allowed) or read and write (writing to path allowed).

  • credentials object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • savedCredentials object
  • id int32
  • name string
  • configuration object

    While adding network access path, please add credentials or saved credentials. If both are provided, credentials will be selected.

  • enableBackupLocation boolean

    Used to enable or disable backup location

  • disableBackupLocationforFutureBackups boolean

    Used to determine if backup location has to be disabled or enabled for future backups

  • prepareForRetirement boolean

    Used to determine if the backup location has to be prepared for retirement

  • backupLocation string

    Can be used to change the disk access path.

  • enabled boolean
Responses

Success

Schema
  • errorMessage string
  • errorCode int32
PUT /v4/storage/disk/:storagepoolid/backuplocation/:backuplocationid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
token
storagePoolId — path required
backupLocationId — path required
Body
{

  "mediaAgent": {

    "id": 0,

    "name": "string"

  },

  "access": "READ_AND_WRITE",

  "credentials": {

    "name": "string",

    "password": "string"

  },

  "savedCredentials": {

    "id": 0,

    "name": "string"

  },

  "configuration": {

    "enableBackupLocation": true,

    "disableBackupLocationforFutureBackups": true,

    "prepareForRetirement": true

  },

  "backupLocation": "string",

  "enabled": true

}

curl -L -X PUT 'https://localhost/webconsole/api/V4/Storage/Disk/:storagePoolId/BackupLocation/:backupLocationId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "mediaAgent": {
    "id": 0,
    "name": "string"
  },
  "access": "READ_AND_WRITE",
  "credentials": {
    "name": "string",
    "password": "string"
  },
  "savedCredentials": {
    "id": 0,
    "name": "string"
  },
  "configuration": {
    "enableBackupLocation": true,
    "disableBackupLocationforFutureBackups": true,
    "prepareForRetirement": true
  },
  "backupLocation": "string",
  "enabled": true
}'