Backup Destinations Controller Resource

The API allows you to list, view, edit and create backup destinations.

GET /backup-destinations

Returns list of backup destinations.

Request Parameters
name type description constraints multivalued
allowed-states query "INITIALIZATION_FAILED" or "INITIALIZED" or "INITIALIZING" or "NOT_INITIALIZED" or "READY_FOR_INITIALIZATION" or "REQUIRED_INITIALIZATION" or "VERIFICATION_FAILED" or "VERIFIED" yes
allowed-types query "AVAMAR" or "AZURE" or "DATAPROTECTOR" or "FILESYSTEM" or "GCS" or "IMPOSSIBLECLOUD" or "ISOLAYER" or "ISP" or "NETBACKUP" or "NETWORKER" or "RUBRIK" or "S3" or "SWIFT" or "SYNTHETICDDBOOST" or "SYNTHETICXFS" or "SYNTHETICZFS" or "TAPEPOOL" or "VSTOR" yes
direction query   no
filter query   no
nameLike query   no
orderBy query   no
page query   no
project-uuid query   no
size query   no
type query "AVAMAR" or "AZURE" or "DATAPROTECTOR" or "FILESYSTEM" or "GCS" or "IMPOSSIBLECLOUD" or "ISOLAYER" or "ISP" or "NETBACKUP" or "NETWORKER" or "RUBRIK" or "S3" or "SWIFT" or "SYNTHETICDDBOOST" or "SYNTHETICXFS" or "SYNTHETICZFS" or "TAPEPOOL" or "VSTOR" no
Response Body
media type data type description
application/json array of BackupDestinationListRecord (JSON) list of backup destinations

Example

Request
GET /backup-destinations
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
} ]

POST /backup-destinations

Create backup destination.

Request Body
media type data type description
application/json BackupDestinationRequest (JSON) specify details for new backup destination
Response Body
media type data type description
application/json BackupDestinationDetails (JSON) details of newly created backup destination

Example

Request
POST /backup-destinations
Content-Type: application/json
Accept: application/json

                
{
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/avamar

Create Avamar backup destination.

Request Body
media type data type description
application/json AvamarBackupDestinationRequest (JSON) specify details for new Avamar backup destination
Response Body
media type data type description
application/json AvamarBackupDestinationDetails (JSON) details of newly created Avamar backup destination

Example

Request
POST /backup-destinations/avamar
Content-Type: application/json
Accept: application/json

                
{
  "account" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "account" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/azure

Create Microsoft Azure Blob Storage backup destination.

Request Body
media type data type description
application/json AzureBackupDestinationRequest (JSON) specify details for new Microsoft Azure Blob Storage backup destination
Response Body
media type data type description
application/json AzureBackupDestinationDetails (JSON) details of newly created Microsoft Azure Blob Storage backup destination

Example

Request
POST /backup-destinations/azure
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "backupMode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/dataprotector

Create OpenText Data Protector backup destination.

Request Body
media type data type description
application/json DataProtectorBackupDestinationRequest (JSON) specify details for new OpenText Data Protector backup destination
Response Body
media type data type description
application/json DataProtectorBackupDestinationDetails (JSON) details of newly created OpenText Data Protector backup destination

Example

Request
POST /backup-destinations/dataprotector
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/filesystem

Create filesystem backup destination.

Request Body
media type data type description
application/json FileSystemBackupDestinationRequest (JSON) specify details for new filesystem backup destination
Response Body
media type data type description
application/json FileSystemBackupDestinationDetails (JSON) details of newly created filesystem backup destination

Example

Request
POST /backup-destinations/filesystem
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/gcs

Create Google Cloud Storage (GCS) backup destination.

Request Body
media type data type description
application/json GcsBackupDestinationRequest (JSON) specify details for new Google Cloud Storage (GCS) backup destination
Response Body
media type data type description
application/json GcsBackupDestinationDetails (JSON) details of newly created Google Cloud Storage (GCS) backup destination

Example

Request
POST /backup-destinations/gcs
Content-Type: application/json
Accept: application/json

                
{
  "bucketName" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "bucketName" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/impossiblecloud

Create Impossible Cloud backup destination.

Request Body
media type data type description
application/json ImpossibleCloudBackupDestinationRequest (JSON) specify details for new Impossible Cloud backup destination
Response Body
media type data type description
application/json ImpossibleCloudBackupDestinationDetails (JSON) details of newly created Impossible Cloud backup destination

Example

Request
POST /backup-destinations/impossiblecloud
Content-Type: application/json
Accept: application/json

                
{
  "backupMode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "backupMode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/isolayer

Create isolayer backup destination.

Request Body
media type data type description
application/json IsoLayerBackupDestinationRequest (JSON) specify details for new isolayer backup destination
Response Body
media type data type description
application/json IsoLayerBackupDestinationDetails (JSON) details of newly created isolayer backup destination

Example

Request
POST /backup-destinations/isolayer
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/isp

Create IBM Spectrum Protect (ISP) backup destination.

Request Body
media type data type description
application/json IspBackupDestinationRequest (JSON) specify details for new IBM Spectrum Protect (ISP) backup destination
Response Body
media type data type description
application/json IspBackupDestinationDetails (JSON) details of newly created IBM Spectrum Protect (ISP) backup destination

Example

Request
POST /backup-destinations/isp
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/netbackup

Create Veritas Netbackup backup destination.

Request Body
media type data type description
application/json NetBackupBackupDestinationRequest (JSON) specify details for new Veritas Netbackup backup destination
Response Body
media type data type description
application/json NetBackupBackupDestinationDetails (JSON) details of newly created Veritas Netbackup backup destination

Example

Request
POST /backup-destinations/netbackup
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/networker

Create Dell EMC Networker backup destination.

Request Body
media type data type description
application/json NetWorkerBackupDestinationRequest (JSON) specify details for new Dell EMC Networker backup destination
Response Body
media type data type description
application/json NetWorkerBackupDestinationDetails (JSON) details of newly created Dell EMC Networker backup destination

Example

Request
POST /backup-destinations/networker
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/reduced

Returns list of backup destinations list of reduced list records for reporting view or backup sla form update

Request Parameters
name type description constraints multivalued
allowed-states query "INITIALIZATION_FAILED" or "INITIALIZED" or "INITIALIZING" or "NOT_INITIALIZED" or "READY_FOR_INITIALIZATION" or "REQUIRED_INITIALIZATION" or "VERIFICATION_FAILED" or "VERIFIED" yes
allowed-types query "AVAMAR" or "AZURE" or "DATAPROTECTOR" or "FILESYSTEM" or "GCS" or "IMPOSSIBLECLOUD" or "ISOLAYER" or "ISP" or "NETBACKUP" or "NETWORKER" or "RUBRIK" or "S3" or "SWIFT" or "SYNTHETICDDBOOST" or "SYNTHETICXFS" or "SYNTHETICZFS" or "TAPEPOOL" or "VSTOR" yes
direction query   no
filter query   no
nameLike query   no
orderBy query   no
page query   no
project-uuid query   no
size query   no
type query "AVAMAR" or "AZURE" or "DATAPROTECTOR" or "FILESYSTEM" or "GCS" or "IMPOSSIBLECLOUD" or "ISOLAYER" or "ISP" or "NETBACKUP" or "NETWORKER" or "RUBRIK" or "S3" or "SWIFT" or "SYNTHETICDDBOOST" or "SYNTHETICXFS" or "SYNTHETICZFS" or "TAPEPOOL" or "VSTOR" no
Response Body
media type data type description
application/json array of BackupDestinationReducedListRecord (JSON) list of backup destinations list of reduced list records

Example

Request
GET /backup-destinations/reduced
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]

POST /backup-destinations/rubrik

Request Body
media type data type
application/json RubrikBackupDestinationRequest (JSON)
Response Body
media type data type description
application/json RubrikBackupDestinationDetails (JSON)

Example

Request
POST /backup-destinations/rubrik
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/s3

Create Amazon S3 backup destination.

Request Body
media type data type description
application/json AmazonS3BackupDestinationRequest (JSON) specify details for new Amazon S3 backup destination
Response Body
media type data type description
application/json AmazonS3BackupDestinationDetails (JSON) details of newly created Amazon S3 backup destination

Example

Request
POST /backup-destinations/s3
Content-Type: application/json
Accept: application/json

                
{
  "backupMode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "backupMode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/swift

Get a single OpenStack Swift backup destination.

Request Parameters
name type description constraints multivalued
allowed-states query "INITIALIZATION_FAILED" or "INITIALIZED" or "INITIALIZING" or "NOT_INITIALIZED" or "READY_FOR_INITIALIZATION" or "REQUIRED_INITIALIZATION" or "VERIFICATION_FAILED" or "VERIFIED" yes
allowed-types query "AVAMAR" or "AZURE" or "DATAPROTECTOR" or "FILESYSTEM" or "GCS" or "IMPOSSIBLECLOUD" or "ISOLAYER" or "ISP" or "NETBACKUP" or "NETWORKER" or "RUBRIK" or "S3" or "SWIFT" or "SYNTHETICDDBOOST" or "SYNTHETICXFS" or "SYNTHETICZFS" or "TAPEPOOL" or "VSTOR" yes
direction query   no
filter query   no
nameLike query   no
orderBy query   no
page query   no
project-uuid query   no
size query   no
type query "AVAMAR" or "AZURE" or "DATAPROTECTOR" or "FILESYSTEM" or "GCS" or "IMPOSSIBLECLOUD" or "ISOLAYER" or "ISP" or "NETBACKUP" or "NETWORKER" or "RUBRIK" or "S3" or "SWIFT" or "SYNTHETICDDBOOST" or "SYNTHETICXFS" or "SYNTHETICZFS" or "TAPEPOOL" or "VSTOR" no
Response Body
media type data type description
application/json array of SwiftBackupDestinationDetails (JSON) OpenStack Swift backup destination details

Example

Request
GET /backup-destinations/swift
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
} ]

POST /backup-destinations/swift

Create OpenStack Swift backup destination.

Request Body
media type data type description
application/json SwiftBackupDestinationWithPasswordRequest (JSON) specify details for new OpenStack Swift backup destination
Response Body
media type data type description
application/json SwiftBackupDestinationDetails (JSON) details of newly created OpenStack Swift backup destination

Example

Request
POST /backup-destinations/swift
Content-Type: application/json
Accept: application/json

                
{
  "authMethod" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "authScope" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "compressionType" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/syntheticddboost

Create DDBoost backup destination.

Request Body
media type data type description
application/json DDBoostBackupDestinationRequest (JSON) specify details for new DDBoost backup destination
Response Body
media type data type description
application/json DDBoostBackupDestinationDetails (JSON) details of newly created DDBoost backup destination

Example

Request
POST /backup-destinations/syntheticddboost
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/syntheticxfs

Create filesystem backup destination.

Request Body
media type data type description
application/json XfsBackupDestinationRequest (JSON) specify details for new filesystem backup destination
Response Body
media type data type description
application/json FileSystemBackupDestinationDetails (JSON) details of newly created filesystem backup destination

Example

Request
POST /backup-destinations/syntheticxfs
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/tapepool

Create tape pool pool backup destination.

Request Body
media type data type description
application/json TapePoolBackupDestinationRequest (JSON) specify details for new tape pool pool backup destination
Response Body
media type data type description
application/json TapePoolBackupDestinationDetails (JSON) details of newly created tape pool pool backup destination

Example

Request
POST /backup-destinations/tapepool
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/usable-for-apps

Returns list of backup destinations which are usable for applications.

Request Body
media type data type description
application/json array of NameAndGuid (JSON) specify list of application guids (local unique identifier for applications use by vProtect)
Response Body
media type data type description
application/json array of BackupDestinationListRecord (JSON) list of backup destinations which are usable for applications

Example

Request
POST /backup-destinations/usable-for-apps
Content-Type: application/json
Accept: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "name" : "Entity name"
} ]
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
} ]

POST /backup-destinations/usable-for-cloud-groups

Returns list of backup destinations which are usable for cloud groups.

Request Body
media type data type description
application/json array of NameAndGuid (JSON) specify list of cloud group guids (local unique identifier for cloud group use by vProtect)
Response Body
media type data type description
application/json array of BackupDestinationListRecord (JSON) list of backup destinations which are usable for cloud groups

Example

Request
POST /backup-destinations/usable-for-cloud-groups
Content-Type: application/json
Accept: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "name" : "Entity name"
} ]
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
} ]

POST /backup-destinations/usable-for-cloud-sites

Returns list of backup destinations which are usable for cloud sites.

Request Body
media type data type description
application/json array of NameAndGuid (JSON) specify list of cloud site guids (local unique identifier for cloud site use by vProtect)
Response Body
media type data type description
application/json array of BackupDestinationListRecord (JSON) list of backup destinations which are usable for cloud sites

Example

Request
POST /backup-destinations/usable-for-cloud-sites
Content-Type: application/json
Accept: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "name" : "Entity name"
} ]
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
} ]

POST /backup-destinations/usable-for-cloud-users

Returns list of backup destinations which are usable for cloud users.

Request Body
media type data type description
application/json array of NameAndGuid (JSON) specify list of cloud user guids (local unique identifier for cloud user use by vProtect)
Response Body
media type data type description
application/json array of BackupDestinationListRecord (JSON) list of backup destinations which are usable for cloud users

Example

Request
POST /backup-destinations/usable-for-cloud-users
Content-Type: application/json
Accept: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "name" : "Entity name"
} ]
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
} ]

POST /backup-destinations/usable-for-storages

Returns list of backup destinations which are usable for storages.

Request Body
media type data type description
application/json array of NameAndGuid (JSON) specify list of storage guids (local unique identifier for storages use by vProtect)
Response Body
media type data type description
application/json array of BackupDestinationListRecord (JSON) list of backup destinations which are usable for storages

Example

Request
POST /backup-destinations/usable-for-storages
Content-Type: application/json
Accept: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "name" : "Entity name"
} ]
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
} ]

POST /backup-destinations/usable-for-vms

Returns list of backup destinations which are usable for virtual machines.

Request Parameters
name type description
project-uuid query
Request Body
media type data type description
application/json array of NameAndGuid (JSON) specify list of virtual machine guids (local unique identifier for virtual machines use by vProtect)
Response Body
media type data type description
application/json array of BackupDestinationListRecord (JSON) list of backup destinations which are usable for virtual machines

Example

Request
POST /backup-destinations/usable-for-vms
Content-Type: application/json
Accept: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "name" : "Entity name"
} ]
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
} ]

POST /backup-destinations/vstor

Create vStor backup destination.

Request Body
media type data type description
application/json VStorBackupDestinationRequest (JSON) specify details for new vStor backup destination
Response Body
media type data type description
application/json VStorBackupDestinationDetails (JSON) details of newly created vStor backup destination

Example

Request
POST /backup-destinations/vstor
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/warnings

Remove warnings for specified backup destination.

Request Body
media type data type description
application/json WarningAcknowledgementRequest (JSON) specify warning acknowledgement request for backup destinations

Example

Request
PUT /backup-destinations/warnings
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

DELETE /backup-destinations/{guid}

Remove backup destination.

Request Parameters
name type description
guid path specify local unique identifier for backup destination (use by vProtect)

Example

Request
DELETE /backup-destinations/{guid}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /backup-destinations/{guid}

Get a single backup destination.

Request Parameters
name type description
guid path specify local unique identifier for backup destination (use by vProtect)
Response Body
media type data type description
application/json BackupDestinationDetails (JSON) backup destination details

Example

Request
GET /backup-destinations/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/avamar/{guid}

Get a single Avamar backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Avamar backup destination (use by vProtect)
Response Body
media type data type description
application/json AvamarBackupDestinationDetails (JSON) Avamar backup destination details

Example

Request
GET /backup-destinations/avamar/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "account" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/avamar/{guid}

Change Avamar backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for Avamar backup destination (use by vProtect)
Request Body
media type data type description
application/json AvamarBackupDestinationRequest (JSON) specify Avamar backup destination details to update
Response Body
media type data type description
application/json AvamarBackupDestinationDetails (JSON) updated details of Avamar backup destination

Example

Request
PUT /backup-destinations/avamar/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "account" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "account" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/azure/{guid}

Get a single Microsoft Azure Blob Storage backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Microsoft Azure Blob Storage backup destination (use by vProtect)
Response Body
media type data type description
application/json AzureBackupDestinationDetails (JSON) Microsoft Azure Blob Storage backup destination details

Example

Request
GET /backup-destinations/azure/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "backupMode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/azure/{guid}

Change Microsoft Azure Blob Storage backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for Microsoft Azure Blob Storage backup destination (use by vProtect)
Request Body
media type data type description
application/json AzureBackupDestinationRequest (JSON) specify Microsoft Azure Blob Storage backup destination details to update
Response Body
media type data type description
application/json AzureBackupDestinationDetails (JSON) updated details of Microsoft Azure Blob Storage backup destination

Example

Request
PUT /backup-destinations/azure/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "backupMode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/dataprotector/{guid}

Get a single OpenText Data Protector backup destination.

Request Parameters
name type description
guid path specify local unique identifier for OpenText Data Protector backup destination (use by vProtect)
Response Body
media type data type description
application/json DataProtectorBackupDestinationDetails (JSON) OpenText Data Protector backup destination details

Example

Request
GET /backup-destinations/dataprotector/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/dataprotector/{guid}

Change OpenText Data Protector backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for OpenText Data Protector backup destination (use by vProtect)
Request Body
media type data type description
application/json DataProtectorBackupDestinationRequest (JSON) specify OpenText Data Protector backup destination details to update
Response Body
media type data type description
application/json DataProtectorBackupDestinationDetails (JSON) updated details of OpenText Data Protector backup destination

Example

Request
PUT /backup-destinations/dataprotector/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/filesystem/{guid}

Get a single filesystem backup destination.

Request Parameters
name type description
guid path specify local unique identifier for filesystem backup destination (use by vProtect)
Response Body
media type data type description
application/json FileSystemBackupDestinationDetails (JSON) filesystem backup destination details

Example

Request
GET /backup-destinations/filesystem/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/filesystem/{guid}

Change filesystem backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for filesystem backup destination (use by vProtect)
Request Body
media type data type description
application/json FileSystemBackupDestinationRequest (JSON) specify filesystem backup destination details to update
Response Body
media type data type description
application/json FileSystemBackupDestinationDetails (JSON) updated details of filesystem backup destination

Example

Request
PUT /backup-destinations/filesystem/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/gcs/{guid}

Get a single Google Cloud Storage (GCS) backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Google Cloud Storage (GCS) backup destination (use by vProtect)
Response Body
media type data type description
application/json GcsBackupDestinationDetails (JSON) Google Cloud Storage (GCS) backup destination details

Example

Request
GET /backup-destinations/gcs/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "bucketName" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/gcs/{guid}

Change Google Cloud Storage (GCS) backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for Google Cloud Storage (GCS) backup destination (use by vProtect)
Request Body
media type data type description
application/json GcsBackupDestinationUpdate (JSON) specify Google Cloud Storage (GCS) backup destination details to update
Response Body
media type data type description
application/json GcsBackupDestinationDetails (JSON) updated details of Google Cloud Storage (GCS) backup destination

Example

Request
PUT /backup-destinations/gcs/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "bucketName" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "bucketName" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/impossiblecloud/{guid}

Get a single Impossible Cloud backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Impossible Cloud backup destination (use by vProtect)
Response Body
media type data type description
application/json ImpossibleCloudBackupDestinationDetails (JSON) Impossible Cloud backup destination details

Example

Request
GET /backup-destinations/impossiblecloud/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "backupMode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/impossiblecloud/{guid}

Change Impossible Cloud backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for Impossible Cloud backup destination (use by vProtect)
Request Body
media type data type description
application/json ImpossibleCloudBackupDestinationRequest (JSON) specify Impossible Cloud backup destination details to update
Response Body
media type data type description
application/json ImpossibleCloudBackupDestinationDetails (JSON) updated details of Impossible Cloud backup destination

Example

Request
PUT /backup-destinations/impossiblecloud/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "backupMode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "backupMode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/isolayer/{guid}

Get a single isolayer backup destination.

Request Parameters
name type description
guid path specify local unique identifier for isolayer backup destination (use by vProtect)
Response Body
media type data type description
application/json IsoLayerBackupDestinationDetails (JSON) isolayer backup destination details

Example

Request
GET /backup-destinations/isolayer/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/isolayer/{guid}

Change isolayer backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for isolayer backup destination (use by vProtect)
Request Body
media type data type description
application/json IsoLayerBackupDestinationRequest (JSON) specify isolayer backup destination details to update
Response Body
media type data type description
application/json IsoLayerBackupDestinationDetails (JSON) updated details of isolayer backup destination

Example

Request
PUT /backup-destinations/isolayer/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/isp/{guid}

Get a single IBM Spectrum Protect (ISP) backup destination.

Request Parameters
name type description
guid path specify local unique identifier for IBM Spectrum Protect (ISP) backup destination (use by vProtect)
Response Body
media type data type description
application/json IspBackupDestinationDetails (JSON) IBM Spectrum Protect (ISP) backup destination details

Example

Request
GET /backup-destinations/isp/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/isp/{guid}

Change IBM Spectrum Protect (ISP) backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for IBM Spectrum Protect (ISP) backup destination (use by vProtect)
Request Body
media type data type description
application/json IspBackupDestinationRequest (JSON) specify IBM Spectrum Protect (ISP) backup destination details to update
Response Body
media type data type description
application/json IspBackupDestinationDetails (JSON) updated details of IBM Spectrum Protect (ISP) backup destination

Example

Request
PUT /backup-destinations/isp/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/netbackup/{guid}

Get a single Veritas Netbackup backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Veritas Netbackup backup destination (use by vProtect)
Response Body
media type data type description
application/json NetBackupBackupDestinationDetails (JSON) Veritas Netbackup backup destination details

Example

Request
GET /backup-destinations/netbackup/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/netbackup/{guid}

Change Veritas Netbackup backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for Veritas Netbackup backup destination (use by vProtect)
Request Body
media type data type description
application/json NetBackupBackupDestinationRequest (JSON) specify Veritas Netbackup backup destination details to update
Response Body
media type data type description
application/json NetBackupBackupDestinationDetails (JSON) updated details of Veritas Netbackup backup destination

Example

Request
PUT /backup-destinations/netbackup/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/networker/{guid}

Get a single Dell EMC Networker backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Dell EMC Networker backup destination (use by vProtect)
Response Body
media type data type description
application/json NetWorkerBackupDestinationDetails (JSON) Dell EMC Networker backup destination details

Example

Request
GET /backup-destinations/networker/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/networker/{guid}

Change Dell EMC Networker backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for Dell EMC Networker backup destination (use by vProtect)
Request Body
media type data type description
application/json NetWorkerBackupDestinationRequest (JSON) specify Dell EMC Networker backup destination details to update
Response Body
media type data type description
application/json NetWorkerBackupDestinationDetails (JSON) updated details of Dell EMC Networker backup destination

Example

Request
PUT /backup-destinations/networker/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/reinit/filesystem

Reinitialize expected to be mounted information for specified filesystem backup destination.

Request Body
media type data type description
application/json LocalMetadataReinitializeRequest (JSON) specify expected to be mounted info for filesystem backup destination (use by vProtect)
Response Body
media type data type description
application/json BackupDestinationDetails (JSON) backup destination details

Example

Request
POST /backup-destinations/reinit/filesystem
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/rubrik/{guid}

Request Parameters
name type description
guid path
Response Body
media type data type description
application/json RubrikBackupDestinationDetails (JSON)

Example

Request
GET /backup-destinations/rubrik/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/rubrik/{guid}

Request Parameters
name type description
guid path
Request Body
media type data type
application/json RubrikBackupDestinationRequest (JSON)
Response Body
media type data type description
application/json RubrikBackupDestinationDetails (JSON)

Example

Request
PUT /backup-destinations/rubrik/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/s3/{guid}

Get a single Amazon S3 backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Amazon S3 backup destination (use by vProtect)
Response Body
media type data type description
application/json AmazonS3BackupDestinationDetails (JSON) Amazon S3 backup destination details

Example

Request
GET /backup-destinations/s3/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "backupMode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/s3/{guid}

Change Amazon S3 backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for Amazon S3 backup destination (use by vProtect)
Request Body
media type data type description
application/json AmazonS3BackupDestinationRequest (JSON) specify Amazon S3 backup destination details to update
Response Body
media type data type description
application/json AmazonS3BackupDestinationDetails (JSON) updated details of Amazon S3 backup destination

Example

Request
PUT /backup-destinations/s3/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "backupMode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "backupMode" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/swift/{guid}

Request Parameters
name type description
guid path
Response Body
media type data type description
application/json SwiftBackupDestinationDetails (JSON)

Example

Request
GET /backup-destinations/swift/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/swift/{guid}

Change OpenStack Swift backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for OpenStack Swift backup destination (use by vProtect)
Request Body
media type data type description
application/json SwiftBackupDestinationRequest (JSON) specify OpenStack Swift backup destination details to update
Response Body
media type data type description
application/json SwiftBackupDestinationDetails (JSON) updated details of OpenStack Swift backup destination

Example

Request
PUT /backup-destinations/swift/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "authMethod" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "authScope" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "compressionType" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  }
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/syntheticddboost/{guid}

Get a single DDBoost backup destination.

Request Parameters
name type description
guid path specify local unique identifier for DDBoost backup destination (use by vProtect)
Response Body
media type data type description
application/json DDBoostBackupDestinationDetails (JSON) DDBoost backup destination details

Example

Request
GET /backup-destinations/syntheticddboost/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/syntheticddboost/{guid}

Change DDBoost backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for DDBoost backup destination (use by vProtect)
Request Body
media type data type description
application/json DDBoostBackupDestinationRequest (JSON) specify DDBoost backup destination details to update
Response Body
media type data type description
application/json DDBoostBackupDestinationDetails (JSON) updated details of DDBoost backup destination

Example

Request
PUT /backup-destinations/syntheticddboost/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/syntheticxfs/{guid}

Get a single filesystem backup destination.

Request Parameters
name type description
guid path specify local unique identifier for filesystem backup destination (use by vProtect)
Response Body
media type data type description
application/json XfsBackupDestinationDetails (JSON) filesystem backup destination details

Example

Request
GET /backup-destinations/syntheticxfs/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/syntheticxfs/{guid}

Change filesystem backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for filesystem backup destination (use by vProtect)
Request Body
media type data type description
application/json XfsBackupDestinationRequest (JSON) specify filesystem backup destination details to update
Response Body
media type data type description
application/json FileSystemBackupDestinationDetails (JSON) updated details of filesystem backup destination

Example

Request
PUT /backup-destinations/syntheticxfs/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/tapepool/{guid}

Get a single tape pool backup destination.

Request Parameters
name type description
guid path specify local unique identifier for tape pool backup destination (use by vProtect)
Response Body
media type data type description
application/json TapePoolBackupDestinationDetails (JSON) tape pool backup destination details

Example

Request
GET /backup-destinations/tapepool/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/tapepool/{guid}

Change tape pool backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for tape pool backup destination (use by vProtect)
Request Body
media type data type description
application/json TapePoolBackupDestinationRequest (JSON) specify tape pool backup destination details to update
Response Body
media type data type description
application/json TapePoolBackupDestinationDetails (JSON) updated details of tape pool backup destination

Example

Request
PUT /backup-destinations/tapepool/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/vstor/{guid}

Get a single vStor backup destination.

Request Parameters
name type description
guid path specify local unique identifier for vStor backup destination (use by vProtect)
Response Body
media type data type description
application/json VStorBackupDestinationDetails (JSON) vStor backup destination details

Example

Request
GET /backup-destinations/vstor/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/vstor/{guid}

Change vStor backup destination details.

Request Parameters
name type description
guid path specify local unique identifier for vStor backup destination (use by vProtect)
Request Body
media type data type description
application/json VStorBackupDestinationRequest (JSON) specify vStor backup destination details to update
Response Body
media type data type description
application/json VStorBackupDestinationDetails (JSON) updated details of vStor backup destination

Example

Request
PUT /backup-destinations/vstor/{guid}
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/{guid}/certificates

Change backup destination certificate settings.

Request Parameters
name type description
guid path specify local unique identifier for backup destination (use by vProtect)
Request Body
media type data type description
application/json BackupDestinationCertificateSettingsUpdate (JSON) specify certificate settings for backup destination
Response Body
media type data type description
application/json BackupDestinationDetails (JSON) updated backup destination details

Example

Request
PUT /backup-destinations/{guid}/certificates
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/{guid}/default

Request Parameters
name type description
guid path
Request Body
media type data type
application/json BooleanDTO (JSON)

Example

Request
PUT /backup-destinations/{guid}/default
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

PUT /backup-destinations/{guid}/fail-initialization

Fail backup destination initialization process.

Request Parameters
name type description
guid path specify local unique identifier for tape pool backup destination (use by vProtect)

Example

Request
PUT /backup-destinations/{guid}/fail-initialization
Content-Type: application/json

                
...
Response
HTTP/1.1 204 No Content

PUT /backup-destinations/{guid}/fail-verification

Fail backup destination verification process.

Request Parameters
name type description
guid path specify local unique identifier for filesystem backup destination (use by vProtect)

Example

Request
PUT /backup-destinations/{guid}/fail-verification
Content-Type: application/json

                
...
Response
HTTP/1.1 204 No Content

PUT /backup-destinations/{guid}/finish-initialization

Finish backup destination initialization process.

Request Parameters
name type description
guid path specify local unique identifier for tape pool backup destination (use by vProtect)

Example

Request
PUT /backup-destinations/{guid}/finish-initialization
Content-Type: application/json

                
...
Response
HTTP/1.1 204 No Content

PUT /backup-destinations/{guid}/finish-verification

Finish backup destination verification process.

Request Parameters
name type description
guid path specify local unique identifier for filesystem backup destination (use by vProtect)

Example

Request
PUT /backup-destinations/{guid}/finish-verification
Content-Type: application/json

                
...
Response
HTTP/1.1 204 No Content

PUT /backup-destinations/{guid}/node-configs

Change node configurations in backup destination.

Request Parameters
name type description
guid path specify local unique identifier for backup destination (use by vProtect)
Request Body
media type data type description
application/json array of NameAndGuid (JSON) specify guids (local unique identifier use by vProtect) for node configurations
Response Body
media type data type description
application/json BackupDestinationDetails (JSON) updated backup destination details

Example

Request
PUT /backup-destinations/{guid}/node-configs
Content-Type: application/json
Accept: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "name" : "Entity name"
} ]
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

POST /backup-destinations/{guid}/reinit

Reinitialize information for specified backup destination.

Request Parameters
name type description
guid path specify local unique identifier for backup destination (use by vProtect)
Response Body
media type data type description
application/json BackupDestinationDetails (JSON) backup destination details

Example

Request
POST /backup-destinations/{guid}/reinit
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

PUT /backup-destinations/{guid}/require-initialization

Require backup destination initialization process.

Request Parameters
name type description
guid path specify local unique identifier for filesystem backup destination (use by vProtect)

Example

Request
PUT /backup-destinations/{guid}/require-initialization
Content-Type: application/json

                
...
Response
HTTP/1.1 204 No Content

GET /backup-destinations/{guid}/size

Get a size of specified backup destination.

Request Parameters
name type description
guid path specify local unique identifier for backup destination (use by vProtect)
Response Body
media type data type description
application/json LongDTO (JSON) backup destination size

Example

Request
GET /backup-destinations/{guid}/size
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

PUT /backup-destinations/{guid}/start-initialization

Start backup destination initialization process.

Request Parameters
name type description
guid path specify local unique identifier for backup destination (use by vProtect)
Response Body
media type data type description
application/json BackupDestinationDetails (JSON) updated details of backup destination

Example

Request
PUT /backup-destinations/{guid}/start-initialization
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

GET /backup-destinations/{guid}/statistics

Request Parameters
name type description constraints
guid path  
compute-zone query  
from query long
to query long
Response Body
media type data type description
application/json BackupDestinationStatisticsDetails (JSON)

Example

Request
GET /backup-destinations/{guid}/statistics
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

GET /backup-destinations/{guid}/statusinfo

Request Parameters
name type description
guid path
Response Body
media type data type description
application/json array of BackupDestinationInitInfoDTO (JSON)

Example

Request
GET /backup-destinations/{guid}/statusinfo
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]

PUT /backup-destinations/{guid}/statusinfo

Request Parameters
name type description
guid path
Request Body
media type data type
application/json BackupDestinationInitInfoDTO (JSON)
Response Body
media type data type description
application/json BackupDestinationDetails (JSON)

Example

Request
PUT /backup-destinations/{guid}/statusinfo
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}

DELETE /backup-destinations/{guid}/warnings

Remove warnings for specified backup destination.

Request Parameters
name type description
guid path specify local unique identifier for backup destination (use by vProtect)

Example

Request
DELETE /backup-destinations/{guid}/warnings
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

PUT /backup-destinations/azure/{guid}/account-key

Change account key for Microsoft Azure Blob Storage backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Microsoft Azure Blob Storage backup destination (use by vProtect)
Request Body
media type data type description
application/json StringDTO (JSON) specify account key for Microsoft Azure Blob Storage backup destination to update

Example

Request
PUT /backup-destinations/azure/{guid}/account-key
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

GET /backup-destinations/gcs/{guid}/service-account-key

Request Parameters
name type description
guid path
Response Body
media type data type description
application/json string (JSON)

Example

Request
GET /backup-destinations/gcs/{guid}/service-account-key
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /backup-destinations/gcs/{guid}/service-account-key

Request Parameters
name type description
guid path
Request Body
media type data type
application/json StringDTO (JSON)

Example

Request
PUT /backup-destinations/gcs/{guid}/service-account-key
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

PUT /backup-destinations/impossiblecloud/{guid}/access-key

Change access key for Impossible Cloud backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Impossible Cloud backup destination (use by vProtect)
Request Body
media type data type description
application/json StringDTO (JSON) specify access key for Impossible Cloud backup destination to update

Example

Request
PUT /backup-destinations/impossiblecloud/{guid}/access-key
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

GET /backup-destinations/impossiblecloud/{guid}/client-proxy-configuration

Returns client proxy configuration for specified Impossible Cloud backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Impossible Cloud backup destination (use by vProtect)
Response Body
media type data type description
application/json ImpossibleCloudClientProxyConfiguration (JSON) client proxy configuration for specified Impossible Cloud backup destination

Example

Request
GET /backup-destinations/impossiblecloud/{guid}/client-proxy-configuration
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

GET /backup-destinations/impossiblecloud/{guid}/keys

Returns access and secret key for specified Impossible Cloud backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Impossible Cloud backup destination (use by vProtect)
Response Body
media type data type description
application/json AmazonKeys (JSON) access and secret key for specified Impossible Cloud backup destination

Example

Request
GET /backup-destinations/impossiblecloud/{guid}/keys
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

GET /backup-destinations/impossiblecloud/{guid}/proxy-password

Request Parameters
name type description
guid path
Response Body
media type data type description
application/json string (JSON)

Example

Request
GET /backup-destinations/impossiblecloud/{guid}/proxy-password
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /backup-destinations/impossiblecloud/{guid}/proxy-password

Request Parameters
name type description
guid path
Request Body
media type data type
application/json StringDTO (JSON)

Example

Request
PUT /backup-destinations/impossiblecloud/{guid}/proxy-password
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

PUT /backup-destinations/impossiblecloud/{guid}/secret-key

Change secret key for Impossible Cloud backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Impossible Cloud backup destination (use by vProtect)
Request Body
media type data type description
application/json StringDTO (JSON) specify secret key for Impossible Cloud backup destination to update

Example

Request
PUT /backup-destinations/impossiblecloud/{guid}/secret-key
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

PUT /backup-destinations/isp/{guid}/node-password

Change node password for IBM Spectrum Protect (ISP) backup destination.

Request Parameters
name type description
guid path specify local unique identifier for IBM Spectrum Protect (ISP) backup destination (use by vProtect)
Request Body
media type data type description
application/json StringDTO (JSON) specify new node password for IBM Spectrum Protect (ISP) backup destination to update

Example

Request
PUT /backup-destinations/isp/{guid}/node-password
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

PUT /backup-destinations/s3/{guid}/access-key

Change access key for Amazon S3 backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Amazon S3 backup destination (use by vProtect)
Request Body
media type data type description
application/json StringDTO (JSON) specify access key for Amazon S3 backup destination to update

Example

Request
PUT /backup-destinations/s3/{guid}/access-key
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

GET /backup-destinations/s3/{guid}/client-proxy-configuration

Returns client proxy configuration for specified Amazon S3 backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Amazon S3 backup destination (use by vProtect)
Response Body
media type data type description
application/json AmazonS3ClientProxyConfiguration (JSON) client proxy configuration for specified Amazon S3 backup destination

Example

Request
GET /backup-destinations/s3/{guid}/client-proxy-configuration
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

GET /backup-destinations/s3/{guid}/proxy-password

Request Parameters
name type description
guid path
Response Body
media type data type description
application/json string (JSON)

Example

Request
GET /backup-destinations/s3/{guid}/proxy-password
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /backup-destinations/s3/{guid}/proxy-password

Request Parameters
name type description
guid path
Request Body
media type data type
application/json StringDTO (JSON)

Example

Request
PUT /backup-destinations/s3/{guid}/proxy-password
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

PUT /backup-destinations/s3/{guid}/secret-key

Change secret key for Amazon S3 backup destination.

Request Parameters
name type description
guid path specify local unique identifier for Amazon S3 backup destination (use by vProtect)
Request Body
media type data type description
application/json StringDTO (JSON) specify secret key for Amazon S3 backup destination to update

Example

Request
PUT /backup-destinations/s3/{guid}/secret-key
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

GET /backup-destinations/statistics/{bd-guid}/entity-count

Request Parameters
name type description
bd-guid path
Response Body
media type data type description
application/json number (JSON)

Example

Request
GET /backup-destinations/statistics/{bd-guid}/entity-count
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /backup-destinations/swift/{guid}/password

Change password for OpenStack Swift backup destination.

Request Parameters
name type description
guid path specify local unique identifier for OpenStack Swift backup destination (use by vProtect)
Request Body
media type data type description
application/json StringDTO (JSON) specify password for OpenStack Swift backup destination to update

Example

Request
PUT /backup-destinations/swift/{guid}/password
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

PUT /backup-destinations/syntheticddboost/{guid}/password

Change password for DdBoost backup destination.

Request Parameters
name type description
guid path specify local unique identifier for DdBoost backup destination (used by vProtect)
Request Body
media type data type description
application/json StringDTO (JSON) specify password for DdBoost backup destination to update

Example

Request
PUT /backup-destinations/syntheticddboost/{guid}/password
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content

PUT /backup-destinations/tapepool/{guid}/current-tape

Change tape pool backup destination current tape.

Request Parameters
name type description
guid path specify local unique identifier for tape pool backup destination (use by vProtect)
Request Body
media type data type description
application/json StringDTO (JSON) tape to assign as a current tape
Response Body
media type data type description
application/json TapePoolBackupDestinationDetails (JSON) updated details of tape pool backup destination

Example

Request
PUT /backup-destinations/tapepool/{guid}/current-tape
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "type" : {
    "name" : "ENUM_NAME",
    "description" : "Enum description"
  },
  "modificationTime" : 1451649601000
}