The API allows you to list, view, create and edit cloud backup rule.
Returns list of cloud backup rules filtered by specified query parameters.
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 CloudBackupRuleDetails (JSON) | list of cloud backup rules filtered by specified query parameters |
GET /rules/cloud-backup
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345,
"ruleBackupDestinations" : [ {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345,
"rule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupDestination" : {
"type" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"roleType" : "ARCHIVE",
"backupRetentionSettings" : {
"retentionKeepLastNFull" : 12345,
"retentionKeepFullNewerThan" : 12345,
"retentionKeepLastNIncremental" : 12345,
"retentionKeepIncrementalNewerThan" : 12345,
"keepLastBackupWhenSourceStillExists" : true
}
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345,
"rule" : {
"guid" : "...",
"name" : "..."
},
"backupDestination" : {
"type" : { },
"guid" : "...",
"name" : "..."
},
"roleType" : "PRIMARY",
"backupRetentionSettings" : {
"retentionKeepLastNFull" : 12345,
"retentionKeepFullNewerThan" : 12345,
"retentionKeepLastNIncremental" : 12345,
"retentionKeepIncrementalNewerThan" : 12345,
"keepLastBackupWhenSourceStillExists" : true
}
} ],
"backupCount" : 12345,
"markedForDeletion" : true
} ]
Cloud machine backup rule.
media type | data type | description |
---|---|---|
application/json | CloudBackupRuleRequest (JSON) | specify details for new cloud backup rule |
media type | data type | description |
---|---|---|
application/json | CloudBackupRuleDetails (JSON) | details of newly created cloud backup rule |
POST /rules/cloud-backup
Content-Type: application/json
Accept: application/json
{
"guid" : "...",
"name" : "...",
"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,
"ruleBackupDestinations" : [ {
"type" : "OS",
"guid" : "...",
"backupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"roleType" : "SECONDARY",
"backupRetentionSettings" : {
"retentionKeepLastNFull" : 12345,
"retentionKeepFullNewerThan" : 12345,
"retentionKeepLastNIncremental" : 12345,
"retentionKeepIncrementalNewerThan" : 12345,
"keepLastBackupWhenSourceStillExists" : true
},
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "STORAGE",
"guid" : "...",
"backupDestination" : {
"guid" : "...",
"name" : "..."
},
"roleType" : "SECONDARY",
"backupRetentionSettings" : {
"retentionKeepLastNFull" : 12345,
"retentionKeepFullNewerThan" : 12345,
"retentionKeepLastNIncremental" : 12345,
"retentionKeepIncrementalNewerThan" : 12345,
"keepLastBackupWhenSourceStillExists" : true
},
"daysToKeepRetentionLock" : 12345,
"active" : true
} ]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345,
"ruleBackupDestinations" : [ {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345,
"rule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupDestination" : {
"type" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"roleType" : "ARCHIVE",
"backupRetentionSettings" : {
"retentionKeepLastNFull" : 12345,
"retentionKeepFullNewerThan" : 12345,
"retentionKeepLastNIncremental" : 12345,
"retentionKeepIncrementalNewerThan" : 12345,
"keepLastBackupWhenSourceStillExists" : true
}
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345,
"rule" : {
"guid" : "...",
"name" : "..."
},
"backupDestination" : {
"type" : { },
"guid" : "...",
"name" : "..."
},
"roleType" : "ARCHIVE",
"backupRetentionSettings" : {
"retentionKeepLastNFull" : 12345,
"retentionKeepFullNewerThan" : 12345,
"retentionKeepLastNIncremental" : 12345,
"retentionKeepIncrementalNewerThan" : 12345,
"keepLastBackupWhenSourceStillExists" : true
}
} ],
"backupCount" : 12345,
"markedForDeletion" : true
}
Remove cloud backup rule.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for cloud backup rule (use by vProtect) |
DELETE /rules/cloud-backup/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single cloud backup rule.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for cloud backup rule (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | CloudBackupRuleDetails (JSON) | a single cloud backup rule details |
GET /rules/cloud-backup/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345,
"ruleBackupDestinations" : [ {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345,
"rule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupDestination" : {
"type" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"roleType" : "PRIMARY",
"backupRetentionSettings" : {
"retentionKeepLastNFull" : 12345,
"retentionKeepFullNewerThan" : 12345,
"retentionKeepLastNIncremental" : 12345,
"retentionKeepIncrementalNewerThan" : 12345,
"keepLastBackupWhenSourceStillExists" : true
}
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345,
"rule" : {
"guid" : "...",
"name" : "..."
},
"backupDestination" : {
"type" : { },
"guid" : "...",
"name" : "..."
},
"roleType" : "PRIMARY",
"backupRetentionSettings" : {
"retentionKeepLastNFull" : 12345,
"retentionKeepFullNewerThan" : 12345,
"retentionKeepLastNIncremental" : 12345,
"retentionKeepIncrementalNewerThan" : 12345,
"keepLastBackupWhenSourceStillExists" : true
}
} ],
"backupCount" : 12345,
"markedForDeletion" : true
}
Change cloud backup rule details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for cloud backup rule (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | CloudBackupRuleRequest (JSON) | specify cloud backup rule details to update |
media type | data type | description |
---|---|---|
application/json | CloudBackupRuleDetails (JSON) | updated details of cloud backup rule |
PUT /rules/cloud-backup/{guid}
Content-Type: application/json
Accept: application/json
{
"guid" : "...",
"name" : "...",
"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,
"ruleBackupDestinations" : [ {
"type" : "VIRTUAL_MACHINE",
"guid" : "...",
"backupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"roleType" : "PRIMARY",
"backupRetentionSettings" : {
"retentionKeepLastNFull" : 12345,
"retentionKeepFullNewerThan" : 12345,
"retentionKeepLastNIncremental" : 12345,
"retentionKeepIncrementalNewerThan" : 12345,
"keepLastBackupWhenSourceStillExists" : true
},
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "OS",
"guid" : "...",
"backupDestination" : {
"guid" : "...",
"name" : "..."
},
"roleType" : "PRIMARY",
"backupRetentionSettings" : {
"retentionKeepLastNFull" : 12345,
"retentionKeepFullNewerThan" : 12345,
"retentionKeepLastNIncremental" : 12345,
"retentionKeepIncrementalNewerThan" : 12345,
"keepLastBackupWhenSourceStillExists" : true
},
"daysToKeepRetentionLock" : 12345,
"active" : true
} ]
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345,
"ruleBackupDestinations" : [ {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345,
"rule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupDestination" : {
"type" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"roleType" : "ARCHIVE",
"backupRetentionSettings" : {
"retentionKeepLastNFull" : 12345,
"retentionKeepFullNewerThan" : 12345,
"retentionKeepLastNIncremental" : 12345,
"retentionKeepIncrementalNewerThan" : 12345,
"keepLastBackupWhenSourceStillExists" : true
}
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345,
"rule" : {
"guid" : "...",
"name" : "..."
},
"backupDestination" : {
"type" : { },
"guid" : "...",
"name" : "..."
},
"roleType" : "PRIMARY",
"backupRetentionSettings" : {
"retentionKeepLastNFull" : 12345,
"retentionKeepFullNewerThan" : 12345,
"retentionKeepLastNIncremental" : 12345,
"retentionKeepIncrementalNewerThan" : 12345,
"keepLastBackupWhenSourceStillExists" : true
}
} ],
"backupCount" : 12345,
"markedForDeletion" : true
}