Cloud Backup Policies Controller Resource

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

GET /policies/cloud-backup

Returns list of cloud backup policies filtered by specified query parameters.

Request Parameters
name type description default
direction query  
extended query false
filter query  
nameLike query  
orderBy query  
page query  
size query  
Response Body
media type data type description
application/json array of CloudBackupPolicyListRecord (JSON) list of cloud backup policies filtered by specified query parameters

Example

Request
GET /policies/cloud-backup
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "priority" : 50
} ]

POST /policies/cloud-backup

Create cloud backup policy.

Request Body
media type data type description
application/json CloudBackupPolicyRequest (JSON) specify details for new cloud backup policy
Response Body
media type data type description
application/json CloudBackupPolicyDetails (JSON) details of newly created cloud backup policy

Example

Request
POST /policies/cloud-backup
Content-Type: application/json
Accept: application/json

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

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "priority" : 50
}

POST /policies/cloud-backup/auto-assignment-preview

Get auto-assignment preview for all cloud protected entities and given backup policy.

Request Body
media type data type description
application/json CloudBackupPolicyRequest (JSON) specify cloud backup policy details to create preview
Response Body
media type data type description
application/json CloudCommonAutoAssignResultPreviewListRecord (JSON) list of auto-assignment result preview records

Example

Request
POST /policies/cloud-backup/auto-assignment-preview
Content-Type: application/json
Accept: application/json

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

                
{ }

GET /policies/cloud-backup/detailed

Returns detailed list of cloud backup policies.

Response Body
media type data type description
application/json array of CloudBackupPolicyDetails (JSON) detailed list of cloud backup policies

Example

Request
GET /policies/cloud-backup/detailed
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "priority" : 50
} ]

POST /policies/cloud-backup/list-by-entities

Get all the policies and rules from selected protected entities

Request Body
media type data type description
application/json ProtectedEntityPolicyRequest (JSON) containing selected protected entities
Response Body
media type data type description
application/json array of BackupPolicyForBackupListRecord (JSON) list of policies and rules

Example

Request
POST /policies/cloud-backup/list-by-entities
Content-Type: application/json
Accept: application/json

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

                
[ { } ]

GET /policies/cloud-backup/pe-assignment

Response Body
media type data type description
application/json array of NameAndGuid (JSON)

Example

Request
GET /policies/cloud-backup/pe-assignment
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "name" : "Entity name"
} ]

DELETE /policies/cloud-backup/{guid}

Remove cloud backup policy.

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

Example

Request
DELETE /policies/cloud-backup/{guid}
Response
HTTP/1.1 204 No Content

GET /policies/cloud-backup/{guid}

Get a single cloud backup policy.

Request Parameters
name type description
guid path specify local unique identifier for cloud backup policy (use by vProtect)
Response Body
media type data type description
application/json CloudBackupPolicyDetails (JSON) a single cloud backup policy details

Example

Request
GET /policies/cloud-backup/{guid}
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "priority" : 50
}

PUT /policies/cloud-backup/{guid}

Change cloud backup policy details.

Request Parameters
name type description
guid path specify local unique identifier for cloud backup policy (use by vProtect)
Request Body
media type data type description
application/json CloudBackupPolicyRequest (JSON) specify cloud backup policy details to update
Response Body
media type data type description
application/json CloudBackupPolicyDetails (JSON) updated details of cloud backup policy

Example

Request
PUT /policies/cloud-backup/{guid}
Content-Type: application/json
Accept: application/json

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

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "priority" : 50
}

POST /policies/cloud-backup/{guid}/auto-assignment-preview

Get auto-assignment preview for all cloud protected entities and given backup policy.

Request Parameters
name type description
guid path specify local unique identifier for cloud backup policy (use by vProtect)
Request Body
media type data type description
application/json CloudBackupPolicyRequest (JSON) specify cloud backup policy details to create preview
Response Body
media type data type description
application/json CloudCommonAutoAssignResultPreviewListRecord (JSON) list of auto-assignment result preview records

Example

Request
POST /policies/cloud-backup/{guid}/auto-assignment-preview
Content-Type: application/json
Accept: application/json

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

                
{ }

POST /policies/cloud-backup/{guid}/clone

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

Example

Request
POST /policies/cloud-backup/{guid}/clone
Content-Type: application/json
Accept: application/json

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

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "priority" : 50
}

GET /policies/cloud-backup/{guid}/entities

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

Example

Request
GET /policies/cloud-backup/{guid}/entities
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

GET /policies/cloud-backup/{guid}/statistics

Returns architecture statistics from Cloud Backup Policy.

Request Parameters
name type description
guid path specify local unique identifier for Cloud Backup Policy (use by vProtect)
compute-zone query
from query
to query
Response Body
media type data type description
application/json BackupPolicyStatisticsDetailsDto (JSON) architecture statistics from Cloud Backup Policy

Example

Request
GET /policies/cloud-backup/{guid}/statistics
Accept: application/json
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }