- Home
- Resources
- Application Backup Rule Controller
The API allows you to list, view, create and edit application backup rule.
GET /rules/app-backup
Returns list of application 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 AppBackupRuleDetails
(JSON) |
list of application backup rules filtered by specified query parameters |
Example
Request
GET /rules/app-backup
Content-Type: */*
Accept: application/json
...
Response
HTTP/1.1 200 OK
Content-Type: application/json
[ { } ]
POST /rules/app-backup
Create application backup rule.
Request Body
| media type |
data type |
description |
| application/json |
AppBackupRuleRequest
(JSON) |
specify details for new application backup rule |
Response Body
| media type |
data type |
description |
| application/json |
AppBackupRuleDetails
(JSON) |
details of newly created application backup rule |
Example
Request
POST /rules/app-backup
Content-Type: application/json
Accept: application/json
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json
{ }
DELETE /rules/app-backup/{guid}
Remove application backup rule.
Request Parameters
| name |
type |
description |
| guid |
path |
specify local unique identifier for application backup rule (use by vProtect) |
Example
Request
DELETE /rules/app-backup/{guid}
Content-Type: */*
...
Response
HTTP/1.1 204 No Content
GET /rules/app-backup/{guid}
Get a single application backup rule.
Request Parameters
| name |
type |
description |
| guid |
path |
specify local unique identifier for application backup rule (use by vProtect) |
Response Body
| media type |
data type |
description |
| application/json |
AppBackupRuleDetails
(JSON) |
a single application backup rule details |
Example
Request
GET /rules/app-backup/{guid}
Content-Type: */*
Accept: application/json
...
Response
HTTP/1.1 200 OK
Content-Type: application/json
{ }
PUT /rules/app-backup/{guid}
Change application backup rule details.
Request Parameters
| name |
type |
description |
| guid |
path |
specify local unique identifier for application backup rule (use by vProtect) |
Request Body
| media type |
data type |
description |
| application/json |
AppBackupRuleRequest
(JSON) |
specify application backup rule details to update |
Response Body
| media type |
data type |
description |
| application/json |
AppBackupRuleDetails
(JSON) |
updated details of application backup rule |
Example
Request
PUT /rules/app-backup/{guid}
Content-Type: application/json
Accept: application/json
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json
{ }