The API allows you to list and view os protected entities.
Returns list of protected entity by type.
name | type | description |
---|---|---|
protectedEntityType | path | specify type of protected entity |
media type | data type | description |
---|---|---|
application/json | array of OSProtectedEntityDetails (JSON) | list of protected entities |
GET /os-protected-entities/{protectedEntityType}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"sshHost" : "...",
"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_SITE",
"locked" : true,
"beingDeleted" : true,
"osAgent" : {
"sshHost" : "...",
"sshPort" : 12345,
"credential" : {
"guid" : "...",
"name" : "...",
"user" : "...",
"secretKey" : "...",
"sshKey" : "...",
"sshKeyPath" : "...",
"powerShellTransportType" : "SSL"
},
"sshKeyPath" : "...",
"backupCount" : 12345,
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"type" : "APP",
"backupUpToDate" : true,
"restorable" : true,
"lastSuccessfulBackupSize" : 12345,
"lastSuccessfulFullBackupSize" : 12345,
"description" : "...",
"lastLoginDate" : 12345,
"warningsPresent" : true,
"status" : "DECOMMISSIONED",
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"possibleActions" : [ "HVM_READ", "WRITE" ],
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"averageProgress" : 12345.0,
"policy" : {
"rules" : [ { }, { } ],
"name" : "...",
"autoAssignSettings" : { },
"active" : true,
"autoRemoveNonPresent" : true,
"backupRetryCount" : 12345,
"averageBackupSize" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"priority" : 50,
"dailyReportEnabled" : true,
"mailingList" : { }
},
"lastChainMarkedForDeletion" : true,
"enabledScheduledBackups" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"osType" : "WINDOWS",
"lastBackup" : 1451649601000
},
"backupUpToDate" : true,
"policy" : {
"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,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"priority" : 50,
"autoAssignSettings" : {
"mode" : "ASSIGN_AND_REMOVE",
"includeRegExps" : [ "...", "..." ],
"cloudServiceProviders" : [ { }, { } ]
},
"autoRemoveNonPresent" : true,
"averageBackupSize" : 12345,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"backupRetryCount" : 12345,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"cloudFeatures" : [ {
"name" : "ENUM_NAME",
"description" : "Enum description"
}, {
"name" : "...",
"description" : "..."
} ],
"objectsTimeRange" : 12345,
"backupDeletedItemsFolder" : true
},
"restorable" : true,
"lastSuccessfulBackupSize" : 12345,
"present" : true,
"totalBackupSize" : 12345,
"lastSuccessfulFullBackupSize" : 12345,
"description" : "...",
"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,
"lastChainMarkedForDeletion" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"lastBackup" : 1451649601000
} ]
Returns details of protected entity by type and guid.
name | type | description |
---|---|---|
guid | path | specify guid of protected entity |
protectedEntityType | path | specify type of protected entity |
media type | data type | description |
---|---|---|
application/json | OSProtectedEntityDetails (JSON) | protected entity |
GET /os-protected-entities/{protectedEntityType}/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"sshHost" : "...",
"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" : "CLOUD_GROUP",
"locked" : true,
"beingDeleted" : true,
"osAgent" : {
"sshHost" : "...",
"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_TEAMS",
"backupUpToDate" : true,
"restorable" : true,
"lastSuccessfulBackupSize" : 12345,
"lastSuccessfulFullBackupSize" : 12345,
"description" : "...",
"lastLoginDate" : 12345,
"warningsPresent" : true,
"status" : "CONNECTED",
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"possibleActions" : [ "HV_READ", "READ" ],
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"averageProgress" : 12345.0,
"policy" : {
"rules" : [ { }, { } ],
"name" : "...",
"autoAssignSettings" : { },
"active" : true,
"autoRemoveNonPresent" : true,
"backupRetryCount" : 12345,
"averageBackupSize" : 12345,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"priority" : 50,
"dailyReportEnabled" : true,
"mailingList" : { }
},
"lastChainMarkedForDeletion" : true,
"enabledScheduledBackups" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"osType" : "LINUX",
"lastBackup" : 1451649601000
},
"backupUpToDate" : true,
"policy" : {
"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,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"priority" : 50,
"autoAssignSettings" : {
"mode" : "DISABLED",
"includeRegExps" : [ "...", "..." ],
"cloudServiceProviders" : [ { }, { } ]
},
"autoRemoveNonPresent" : true,
"averageBackupSize" : 12345,
"failRemainingBackupTasksExportThreshold" : 12345.0,
"failRemainingBackupTasksStoreThreshold" : 12345.0,
"backupRetryCount" : 12345,
"dailyReportEnabled" : true,
"mailingList" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"cloudFeatures" : [ {
"name" : "ENUM_NAME",
"description" : "Enum description"
}, {
"name" : "...",
"description" : "..."
} ],
"objectsTimeRange" : 12345,
"backupDeletedItemsFolder" : true
},
"restorable" : true,
"lastSuccessfulBackupSize" : 12345,
"present" : true,
"totalBackupSize" : 12345,
"lastSuccessfulFullBackupSize" : 12345,
"description" : "...",
"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,
"lastChainMarkedForDeletion" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"lastBackup" : 1451649601000
}
Returns storage usage of protected entity by type and guid.
name | type | description |
---|---|---|
guid | path | specify guid of protected entity |
protectedEntityType | path | specify type of protected entity |
media type | data type | description |
---|---|---|
application/json | StorageUsage (JSON) | storage usage of protected entity |
GET /os-protected-entities/{protectedEntityType}/{guid}/storage-usage
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"allUsedSPConfigs" : [ "...", "..." ],
"usedSPConfigsForLastVersions" : [ "...", "..." ]
}