The API allows you to list, view, create and edit snapshot management rules for VMs.
Returns list of snapshot management rules.
name | type | description |
---|---|---|
direction | query | |
filter | query | |
nameLike | query | |
orderBy | query | |
page | query | |
policy | query | |
size | query |
media type | data type | description |
---|---|---|
application/json | array of SnapshotMgmtRuleDetails (JSON) | list of snapshot management rules |
GET /rules/vm-snapshot
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"name" : "...",
"retentionVersions" : 12345,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"retentionDays" : 12345,
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ]
Create snapshot management rule.
media type | data type | description |
---|---|---|
application/json | SnapshotMgmtRuleRequest (JSON) | specify details for new snapshot management rule |
media type | data type | description |
---|---|---|
application/json | SnapshotMgmtRuleDetails (JSON) | details of newly created snapshot management rule |
POST /rules/vm-snapshot
Content-Type: application/json
Accept: application/json
{
"retentionVersions" : 12345,
"guid" : "...",
"name" : "...",
"retentionDays" : 12345,
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"position" : 12345
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"retentionVersions" : 12345,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"retentionDays" : 12345,
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
}
Remove snapshot management rule.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for snapshot management rule (use by vProtect) |
DELETE /rules/vm-snapshot/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single snapshot management rule.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for snapshot management rule (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | SnapshotMgmtRuleDetails (JSON) | a single snapshot management rule details |
GET /rules/vm-snapshot/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"retentionVersions" : 12345,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"retentionDays" : 12345,
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
}
Change snapshot management rule details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for snapshot management rule (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | SnapshotMgmtRuleRequest (JSON) | specify snapshot management rule details to update |
media type | data type | description |
---|---|---|
application/json | SnapshotMgmtRuleDetails (JSON) | updated details of snapshot management rule |
PUT /rules/vm-snapshot/{guid}
Content-Type: application/json
Accept: application/json
{
"retentionVersions" : 12345,
"guid" : "...",
"name" : "...",
"retentionDays" : 12345,
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"position" : 12345
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"retentionVersions" : 12345,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"retentionDays" : 12345,
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
}