The API allows you to view, list, create and edit applications.
Returns list of applications filtered by specified query parameters.
name | type | description | constraints | multivalued |
---|---|---|---|---|
appCmdExecConfig | query | yes | ||
backupStatus | query | "IS_PROTECTED" or "NOT_PROTECTED" or "NO_SCHEDULE" | yes | |
direction | query | no | ||
filter | query | no | ||
nameLike | query | no | ||
node-config | query | no | ||
orderBy | query | no | ||
page | query | no | ||
policy | query | yes | ||
size | query | no |
media type | data type | description |
---|---|---|
application/json | array of ApplicationListRecord (JSON) | list of applications filtered by specified query parameters |
GET /applications
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"type" : "CLOUD_USER",
"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" : [ "READ", "WRITE" ],
"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" : [ "HV_READ", "HVM_READ" ],
"rule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastBackup" : 1451649601000
} ]
Create a application.
name | type | description | constraints |
---|---|---|---|
ignoreCheckSupport | query | specify if checking of application support is ignored | required |
media type | data type | description |
---|---|---|
application/json | ApplicationRequest (JSON) | specify data for new application |
media type | data type | description |
---|---|---|
application/json | ApplicationDetails (JSON) | details of newly created application |
POST /applications
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appBackupPolicy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"sshHost" : "...",
"sshPort" : 12345,
"credential" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"sshKeyPath" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"sshPort" : 12345,
"credential" : {
"guid" : "...",
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "CERTIFICATE"
},
"sshKeyPath" : "...",
"backupCount" : 12345,
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"type" : "VM",
"backupUpToDate" : true,
"restorable" : true,
"lastSuccessfulBackupSize" : 12345,
"lastSuccessfulFullBackupSize" : 12345,
"warningsPresent" : true,
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"averageProgress" : 12345.0,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastChainMarkedForDeletion" : true,
"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
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"appCmdExecConfig" : {
"name" : "...",
"cmdArg" : [ "...", "..." ],
"cmdExecMethod" : "NODE",
"exportData" : true,
"removeFilesAfterExport" : true,
"sourceType" : "STREAM",
"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" : [ "HVM_READ", "HV_READ" ],
"instanceCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
},
"sshHost" : "...",
"lastBackup" : 1451649601000,
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfigParam" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "...",
"name" : "..."
},
"appCmdExecConfigParam" : {
"guid" : "...",
"name" : "..."
},
"guid" : "..."
} ],
"possibleActions" : [ "HVM_READ", "READ" ],
"lastStoredSnapshotAssignments" : [ {
"protectedEntitySnapshot" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}, {
"protectedEntitySnapshot" : {
"guid" : "...",
"name" : "..."
},
"application" : {
"guid" : "...",
"name" : "..."
},
"backupRule" : {
"guid" : "...",
"name" : "..."
}
} ]
}
Assign applications to specified policy (or unassign if policy is null)
media type | data type | description |
---|---|---|
application/json | ProtectedEntityBackupPolicyAssignmentRequest (JSON) | containing policy and applications info |
media type | data type | description |
---|---|---|
application/json | array of ApplicationDetails (JSON) | list of updated applications |
POST /applications/assign-backup-policy
Content-Type: application/json
Accept: application/json
{
"backupPolicy" : "...",
"protectedEntities" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
HTTP/1.1 201 Created
Content-Type: application/json
[ {
"sshPort" : 12345,
"credential" : {
"guid" : "...",
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "BASIC"
},
"sshKeyPath" : "...",
"backupCount" : 12345,
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"type" : "CLOUD_USER",
"backupUpToDate" : true,
"restorable" : true,
"lastSuccessfulBackupSize" : 12345,
"lastSuccessfulFullBackupSize" : 12345,
"warningsPresent" : true,
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"averageProgress" : 12345.0,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastChainMarkedForDeletion" : true,
"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
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"appCmdExecConfig" : {
"name" : "...",
"cmdArg" : [ "...", "..." ],
"cmdExecMethod" : "NODE",
"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" : [ "INVENTORY_SYNC", "WRITE" ],
"instanceCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
},
"sshHost" : "...",
"lastBackup" : 1451649601000,
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfigParam" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "...",
"name" : "..."
},
"appCmdExecConfigParam" : {
"guid" : "...",
"name" : "..."
},
"guid" : "..."
} ],
"possibleActions" : [ "READ", "INVENTORY_SYNC" ],
"lastStoredSnapshotAssignments" : [ {
"protectedEntitySnapshot" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}, {
"protectedEntitySnapshot" : {
"guid" : "...",
"name" : "..."
},
"application" : {
"guid" : "...",
"name" : "..."
},
"backupRule" : {
"guid" : "...",
"name" : "..."
}
} ]
} ]
Returns list of protected entities for backup cleanup.
name | type | description |
---|---|---|
backup-destination | query |
media type | data type | description |
---|---|---|
application/json | array of ApplicationListRecord (JSON) | list of protected entities for backup cleanup |
GET /applications/backup-cleanup
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"type" : "APP",
"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" : "NODE",
"exportData" : true,
"removeFilesAfterExport" : true,
"sourceType" : "STREAM",
"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", "INVENTORY_SYNC" ],
"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", "READ" ],
"rule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastBackup" : 1451649601000
} ]
Returns detailed list of applications filtered by specified query parameters.
name | type | description | constraints | multivalued |
---|---|---|---|---|
appCmdExecConfig | query | yes | ||
backupStatus | query | "IS_PROTECTED" or "NOT_PROTECTED" or "NO_SCHEDULE" | yes | |
direction | query | no | ||
filter | query | no | ||
nameLike | query | no | ||
node-config | query | no | ||
orderBy | query | no | ||
page | query | no | ||
policy | query | yes | ||
size | query | no |
media type | data type | description |
---|---|---|
application/json | array of ApplicationDetails (JSON) | detailed list of applications filtered by specified query parameters |
GET /applications/detailed
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"sshPort" : 12345,
"credential" : {
"guid" : "...",
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "CREDSSP"
},
"sshKeyPath" : "...",
"backupCount" : 12345,
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"type" : "CLOUD_USER",
"backupUpToDate" : true,
"restorable" : true,
"lastSuccessfulBackupSize" : 12345,
"lastSuccessfulFullBackupSize" : 12345,
"warningsPresent" : true,
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"averageProgress" : 12345.0,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastChainMarkedForDeletion" : true,
"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
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"appCmdExecConfig" : {
"name" : "...",
"cmdArg" : [ "...", "..." ],
"cmdExecMethod" : "REMOTE_SSH",
"exportData" : true,
"removeFilesAfterExport" : true,
"sourceType" : "STREAM",
"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" : [ "WRITE", "READ" ],
"instanceCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
},
"sshHost" : "...",
"lastBackup" : 1451649601000,
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfigParam" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "...",
"name" : "..."
},
"appCmdExecConfigParam" : {
"guid" : "...",
"name" : "..."
},
"guid" : "..."
} ],
"possibleActions" : [ "HVM_READ", "HV_READ" ],
"lastStoredSnapshotAssignments" : [ {
"protectedEntitySnapshot" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}, {
"protectedEntitySnapshot" : {
"guid" : "...",
"name" : "..."
},
"application" : {
"guid" : "...",
"name" : "..."
},
"backupRule" : {
"guid" : "...",
"name" : "..."
}
} ]
} ]
Returns list of applications filtered by specified query parameters.
name | type | description | constraints |
---|---|---|---|
app-cmd-exec-config | query | ||
cloud-service-provider | query | ||
cluster | query | ||
data-center | query | ||
direction | query | ||
filter | query | ||
hypervisor | query | ||
hypervisor-manager | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
project | query | ||
size | query | ||
storage-pool | query | ||
storage-provider | query | ||
teams-group | query | boolean |
media type | data type | description |
---|---|---|
application/json | array of RbacContextListRecord (JSON) | list of hypervisors filtered by specified query parameters |
GET /applications/rbac-contexts
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"nameAndGuid" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"uuid" : "...",
"type" : "HYPERVISOR_MANAGER",
"checked" : true,
"lastLevel" : true,
"present" : true,
"entityType" : "...",
"childrenQueryType" : "..."
} ]
Remove application.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for application (use by vProtect) |
DELETE /applications/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single application.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for application (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | ApplicationDetails (JSON) | single application details |
GET /applications/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"sshPort" : 12345,
"credential" : {
"guid" : "...",
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "PLAINTEXT"
},
"sshKeyPath" : "...",
"backupCount" : 12345,
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"type" : "VM",
"backupUpToDate" : true,
"restorable" : true,
"lastSuccessfulBackupSize" : 12345,
"lastSuccessfulFullBackupSize" : 12345,
"warningsPresent" : true,
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"averageProgress" : 12345.0,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastChainMarkedForDeletion" : true,
"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
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"appCmdExecConfig" : {
"name" : "...",
"cmdArg" : [ "...", "..." ],
"cmdExecMethod" : "REMOTE_POWERSHELL",
"exportData" : true,
"removeFilesAfterExport" : true,
"sourceType" : "STREAM",
"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", "HV_READ" ],
"instanceCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
},
"sshHost" : "...",
"lastBackup" : 1451649601000,
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfigParam" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "...",
"name" : "..."
},
"appCmdExecConfigParam" : {
"guid" : "...",
"name" : "..."
},
"guid" : "..."
} ],
"possibleActions" : [ "WRITE", "INVENTORY_SYNC" ],
"lastStoredSnapshotAssignments" : [ {
"protectedEntitySnapshot" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}, {
"protectedEntitySnapshot" : {
"guid" : "...",
"name" : "..."
},
"application" : {
"guid" : "...",
"name" : "..."
},
"backupRule" : {
"guid" : "...",
"name" : "..."
}
} ]
}
Change application details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for application (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | ApplicationUpdate (JSON) | specify application details to update |
media type | data type | description |
---|---|---|
application/json | ApplicationDetails (JSON) | updated details of application |
PUT /applications/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"appBackupPolicy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"sshHost" : "...",
"sshPort" : "...",
"sshUser" : "...",
"sshKeyPath" : "...",
"credential" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"sshPort" : 12345,
"credential" : {
"guid" : "...",
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "KERBEROS"
},
"sshKeyPath" : "...",
"backupCount" : 12345,
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"type" : "STORAGE",
"backupUpToDate" : true,
"restorable" : true,
"lastSuccessfulBackupSize" : 12345,
"lastSuccessfulFullBackupSize" : 12345,
"warningsPresent" : true,
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"averageProgress" : 12345.0,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastChainMarkedForDeletion" : true,
"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
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"appCmdExecConfig" : {
"name" : "...",
"cmdArg" : [ "...", "..." ],
"cmdExecMethod" : "REMOTE_POWERSHELL",
"exportData" : true,
"removeFilesAfterExport" : true,
"sourceType" : "STREAM",
"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" : [ "INVENTORY_SYNC", "INVENTORY_SYNC" ],
"instanceCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
},
"sshHost" : "...",
"lastBackup" : 1451649601000,
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfigParam" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "...",
"name" : "..."
},
"appCmdExecConfigParam" : {
"guid" : "...",
"name" : "..."
},
"guid" : "..."
} ],
"possibleActions" : [ "HVM_READ", "READ" ],
"lastStoredSnapshotAssignments" : [ {
"protectedEntitySnapshot" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}, {
"protectedEntitySnapshot" : {
"guid" : "...",
"name" : "..."
},
"application" : {
"guid" : "...",
"name" : "..."
},
"backupRule" : {
"guid" : "...",
"name" : "..."
}
} ]
}
Clone application.
name | type | description |
---|---|---|
guid | path | local unique identifier of application that will be cloned |
media type | data type | description |
---|---|---|
application/json | CloneDTO (JSON) | specify details for new application |
media type | data type | description |
---|---|---|
application/json | ApplicationDetails (JSON) | details of newly created application |
POST /applications/{guid}/clone
Content-Type: application/json
Accept: application/json
{
"name" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"sshPort" : 12345,
"credential" : {
"guid" : "...",
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "NTLM"
},
"sshKeyPath" : "...",
"backupCount" : 12345,
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"type" : "OS_AGENT",
"backupUpToDate" : true,
"restorable" : true,
"lastSuccessfulBackupSize" : 12345,
"lastSuccessfulFullBackupSize" : 12345,
"warningsPresent" : true,
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"averageProgress" : 12345.0,
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastChainMarkedForDeletion" : true,
"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
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"appCmdExecConfig" : {
"name" : "...",
"cmdArg" : [ "...", "..." ],
"cmdExecMethod" : "REMOTE_SSH",
"exportData" : true,
"removeFilesAfterExport" : true,
"sourceType" : "STREAM",
"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", "WRITE" ],
"instanceCount" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
},
"sshHost" : "...",
"lastBackup" : 1451649601000,
"envVariables" : [ {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"appCmdExecConfigParam" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
}, {
"name" : "...",
"value" : "...",
"hiddenInUI" : true,
"application" : {
"guid" : "...",
"name" : "..."
},
"appCmdExecConfigParam" : {
"guid" : "...",
"name" : "..."
},
"guid" : "..."
} ],
"possibleActions" : [ "HVM_READ", "READ" ],
"lastStoredSnapshotAssignments" : [ {
"protectedEntitySnapshot" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"application" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}, {
"protectedEntitySnapshot" : {
"guid" : "...",
"name" : "..."
},
"application" : {
"guid" : "...",
"name" : "..."
},
"backupRule" : {
"guid" : "...",
"name" : "..."
}
} ]
}