OS Backup Rule Controller Resource

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

GET /rules/os-backup

Returns list of os backup rules filtered by specified query parameters.

Request Parameters
name type description
direction query
filter query
nameLike query
orderBy query
page query
policy query
size query
Response Body
media type data type description
application/json array of OSBackupRuleDetails (JSON) list of os backup rules filtered by specified query parameters

Example

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

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

                
[ { } ]

POST /rules/os-backup

OS backup rule.

Request Body
media type data type description
application/json OSBackupRuleRequest (JSON) specify details for new os backup rule
Response Body
media type data type description
application/json OSBackupRuleDetails (JSON) details of newly created os backup rule

Example

Request
POST /rules/os-backup
Content-Type: application/json
Accept: application/json

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

                
{ }

DELETE /rules/os-backup/{guid}

Remove os backup rule.

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

Example

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

                
...
Response
HTTP/1.1 204 No Content

GET /rules/os-backup/{guid}

Get a single os backup rule.

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

Example

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

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

                
{ }

PUT /rules/os-backup/{guid}

Change os backup rule details.

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

Example

Request
PUT /rules/os-backup/{guid}
Content-Type: application/json
Accept: application/json

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

                
{ }