The API allows you to list, view, create and edit application backup policies.
Returns list of application backup policies.
name | type | description | default | constraints |
---|---|---|---|---|
direction | query | |||
extended | query | specify whether list is extended; with default value false | false | boolean |
filter | query | |||
nameLike | query | |||
orderBy | query | |||
page | query | |||
size | query |
media type | data type | description |
---|---|---|
application/json | array of AppBackupPolicyListRecord (JSON) | list of application backup policies |
GET /policies/app-backup
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"ruleCount" : 12345,
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"active" : true,
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"appCount" : 12345,
"ruleBackupDestinations" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"priority" : 50
} ]
Create application backup policy.
media type | data type | description |
---|---|---|
application/json | AppBackupPolicyRequest (JSON) | specify details for new application backup policy |
media type | data type | description |
---|---|---|
application/json | AppBackupPolicyDetails (JSON) | details of newly created application backup policy |
POST /policies/app-backup
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"backupRetryCount" : 12345,
"priority" : 50,
"apps" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"rules" : [ {
"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" : "STORAGE",
"guid" : "...",
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "CLOUD",
"guid" : "...",
"backupDestination" : { },
"roleType" : "ARCHIVE",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
} ]
}, {
"guid" : "...",
"name" : "...",
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "...",
"name" : "..."
},
"position" : 12345,
"ruleBackupDestinations" : [ {
"type" : "CLOUD",
"guid" : "...",
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "OS",
"guid" : "...",
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
} ]
} ],
"active" : true,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"disableCleanOldBackups" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"rules" : [ {
"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
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"apps" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"priority" : 50,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"disableCleanOldBackups" : true
}
Returns detailed list of application backup policies.
media type | data type | description |
---|---|---|
application/json | array of AppBackupPolicyDetails (JSON) | detailed list of application backup policies |
GET /policies/app-backup/detailed
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"rules" : [ {
"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
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"apps" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"priority" : 50,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"disableCleanOldBackups" : true
} ]
Get all the policies and rules from selected protected entities
media type | data type | description |
---|---|---|
application/json | ProtectedEntityPolicyRequest (JSON) | containing selected protected entities |
media type | data type | description |
---|---|---|
application/json | array of BackupPolicyForBackupListRecord (JSON) | list of policies and rules |
POST /policies/app-backup/list-by-entities
Content-Type: application/json
Accept: application/json
{
"protectedEntities" : [ "...", "..." ]
}
HTTP/1.1 201 Created
Content-Type: application/json
[ {
"guid" : "...",
"name" : "...",
"entityCount" : 12345,
"rules" : [ {
"guid" : "...",
"name" : "...",
"markedForDeletion" : true,
"position" : 12345,
"ruleBackupDestinations" : [ {
"backupDestination" : { },
"roleType" : "PRIMARY"
}, {
"backupDestination" : { },
"roleType" : "ARCHIVE"
} ]
}, {
"guid" : "...",
"name" : "...",
"markedForDeletion" : true,
"position" : 12345,
"ruleBackupDestinations" : [ {
"backupDestination" : { },
"roleType" : "PRIMARY"
}, {
"backupDestination" : { },
"roleType" : "SECONDARY"
} ]
} ]
} ]
Remove application backup policy.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for application backup policy (use by vProtect) |
DELETE /policies/app-backup/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single application backup policy.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for application backup policy (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | AppBackupPolicyDetails (JSON) | a single application backup policy details |
GET /policies/app-backup/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"rules" : [ {
"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
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"apps" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"priority" : 50,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"disableCleanOldBackups" : true
}
Change application backup policy details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for application backup policy (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | AppBackupPolicyRequest (JSON) | specify application backup policy details to update |
media type | data type | description |
---|---|---|
application/json | AppBackupPolicyDetails (JSON) | updated details of application backup policy |
PUT /policies/app-backup/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"backupRetryCount" : 12345,
"priority" : 50,
"apps" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"rules" : [ {
"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" : { },
"roleType" : "SECONDARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "STORAGE",
"guid" : "...",
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
} ]
}, {
"guid" : "...",
"name" : "...",
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"policy" : {
"guid" : "...",
"name" : "..."
},
"position" : 12345,
"ruleBackupDestinations" : [ {
"type" : "STORAGE",
"guid" : "...",
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
}, {
"type" : "OS",
"guid" : "...",
"backupDestination" : { },
"roleType" : "PRIMARY",
"backupRetentionSettings" : { },
"daysToKeepRetentionLock" : 12345,
"active" : true
} ]
} ],
"active" : true,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"disableCleanOldBackups" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"rules" : [ {
"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
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"apps" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"priority" : 50,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"disableCleanOldBackups" : true
}
name | type | description |
---|---|---|
guid | path |
media type | data type |
---|---|
application/json | CloneDTO (JSON) |
media type | data type | description |
---|---|---|
application/json | AppBackupPolicyDetails (JSON) |
POST /policies/app-backup/{guid}/clone
Content-Type: application/json
Accept: application/json
{
"name" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"rules" : [ {
"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
}, {
"guid" : "...",
"name" : "...",
"policy" : {
"guid" : "...",
"name" : "..."
},
"schedules" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"apps" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"priority" : 50,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"disableCleanOldBackups" : true
}
name | type | description |
---|---|---|
guid | path |
media type | data type | description |
---|---|---|
application/json | array of ApplicationListRecord (JSON) |
GET /policies/app-backup/{guid}/entities
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"type" : "CLOUD_SITE",
"backupUpToDate" : true,
"restorable" : true,
"lastSuccessfulBackupSize" : 12345,
"lastSuccessfulFullBackupSize" : 12345,
"envVariablesCount" : 12345,
"warningsPresent" : true,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appBackupPolicy" : {
"rules" : [ {
"guid" : "...",
"name" : "...",
"policy" : { },
"schedules" : [ { }, { } ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
}, {
"guid" : "...",
"name" : "...",
"policy" : { },
"schedules" : [ { }, { } ],
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
} ],
"name" : "...",
"active" : true,
"backupRetryCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"apps" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"priority" : 50,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"disableCleanOldBackups" : true
},
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfig" : {
"name" : "...",
"cmdArg" : [ "...", "..." ],
"cmdExecMethod" : "REMOTE_POWERSHELL",
"exportData" : true,
"removeFilesAfterExport" : true,
"sourceType" : "FILE",
"sourcePath" : "...",
"appCmdExecConfigParams" : [ {
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "...",
"envVariables" : [ { }, { } ],
"appCmdExecConfig" : { },
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"showInUi" : true,
"obligatory" : true,
"defaultValue" : "...",
"userFriendlyHint" : "...",
"envVariables" : [ { }, { } ],
"appCmdExecConfig" : { },
"guid" : "..."
} ],
"userModifiable" : true,
"useNetcat" : true,
"possibleActions" : [ "HV_READ", "READ" ],
"instanceCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
},
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"envVariables" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"restoreStatus" : "...",
"possibleActions" : [ "READ", "HVM_READ" ],
"rule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastBackup" : 1451649601000
} ]