Application Backup Policies Controller Resource

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

GET /policies/app-backup

Returns list of application backup policies.

Request Parameters
name type description default
direction query  
extended query specify whether list is extended; with default value false false
filter query  
nameLike query  
orderBy query  
page query  
size query  
Response Body
media type data type description
application/json array of AppBackupPolicyListRecord (JSON) list of application backup policies

Example

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

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

POST /policies/app-backup

Create application backup policy.

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

Example

Request
POST /policies/app-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
}

GET /policies/app-backup/detailed

Returns detailed list of application backup policies.

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

Example

Request
GET /policies/app-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/app-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/app-backup/list-by-entities
Content-Type: application/json
Accept: application/json

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

                
[ { } ]

GET /policies/app-backup/pe-assignment

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

Example

Request
GET /policies/app-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/app-backup/{guid}

Remove application backup policy.

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

Example

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

GET /policies/app-backup/{guid}

Get a single application backup policy.

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

Example

Request
GET /policies/app-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/app-backup/{guid}

Change application backup policy details.

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

Example

Request
PUT /policies/app-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/app-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 AppBackupPolicyDetails (JSON)

Example

Request
POST /policies/app-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/app-backup/{guid}/entities

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

Example

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

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

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

Returns architecture statistics from App Backup Policy.

Request Parameters
name type description
guid path specify local unique identifier for App 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 App Backup Policy

Example

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

                
{ }