Backup Destinations Controller Resource

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

GET /backup-destinations/syntheticzfs

Get a list of zfs backup destinations.

Request Parameters
name type description
zpool-name query specify zpool name for zfs backup destination
Response Body
media type data type description
application/json array of ZfsBackupDestinationDetails (JSON) zfs backup destination details containing provided zpool name

Example

Request
GET /backup-destinations/syntheticzfs
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/syntheticzfs

Create zfs backup destination.

Request Body
media type data type description
application/json ZfsBackupDestinationRequest (JSON) specify details for new zfs backup destination

Example

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

                
{ }
Response
HTTP/1.1 201 Created

GET /backup-destinations/syntheticzfs/{guid}

Get a single zfs backup destination.

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

Example

Request
GET /backup-destinations/syntheticzfs/{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/syntheticzfs/{guid}

Change zfs backup destination details.

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

Example

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

                
{ }
Response
HTTP/1.1 204 No Content