The API allows you to list and view cloud 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 CloudProtectedEntityDetails (JSON) | list of protected entities |
GET /cloud-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" : "CREDSSP"
},
"sshKeyPath" : "...",
"backupCount" : 12345,
"rules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"name" : "...",
"type" : "CLOUD_SITE",
"backupUpToDate" : true,
"firstName" : "...",
"restorable" : true,
"lastName" : "...",
"lastSuccessfulBackupSize" : 12345,
"email" : "...",
"displayName" : "...",
"lastSuccessfulFullBackupSize" : 12345,
"locked" : true,
"warningsPresent" : true,
"beingDeleted" : true,
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"externalSourceId" : "...",
"cloudServiceProvider" : {
"guid" : "...",
"cloudServiceProviderType" : "MICROSOFT365",
"name" : "...",
"tenantId" : "...",
"applications" : [ {
"guid" : "...",
"clientId" : "...",
"clientSecret" : "...",
"secretChanged" : true
}, {
"guid" : "...",
"clientId" : "...",
"clientSecret" : "...",
"secretChanged" : true
} ],
"possibleActions" : [ "READ", "WRITE" ],
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"filterUser" : {
"usageLocation" : [ "...", "..." ],
"country" : [ "...", "..." ],
"officeLocation" : [ "...", "..." ]
}
},
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"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
},
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"present" : true,
"userPurpose" : "UNKNOWN",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"totalBackupSize" : 12345,
"lastBackup" : 1451649601000
} ]
Returns list of protected entity by type, with reduced informations, for UI dropdown.
name | type | description |
---|---|---|
protectedEntityType | path | specify type of protected entity |
media type | data type | description |
---|---|---|
application/json | array of CloudProtectedEntityDropdownRecord (JSON) | list of protected entities |
GET /cloud-protected-entities/{protectedEntityType}/dropdown
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"name" : "...",
"type" : "CLOUD_SITE",
"firstName" : "...",
"lastName" : "...",
"email" : "...",
"displayName" : "...",
"externalSourceId" : "...",
"locked" : true,
"beingDeleted" : true,
"cloudServiceProvider" : {
"guid" : "...",
"cloudServiceProviderType" : "MICROSOFT365",
"name" : "...",
"tenantId" : "...",
"applications" : [ {
"guid" : "...",
"clientId" : "...",
"clientSecret" : "...",
"secretChanged" : true
}, {
"guid" : "...",
"clientId" : "...",
"clientSecret" : "...",
"secretChanged" : true
} ],
"possibleActions" : [ "HVM_READ", "HVM_READ" ],
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"filterUser" : {
"usageLocation" : [ "...", "..." ],
"country" : [ "...", "..." ],
"officeLocation" : [ "...", "..." ]
}
},
"present" : true,
"userPurpose" : "LINKED"
} ]
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 | CloudProtectedEntityDetails (JSON) | protected entity |
GET /cloud-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",
"backupUpToDate" : true,
"firstName" : "...",
"restorable" : true,
"lastName" : "...",
"lastSuccessfulBackupSize" : 12345,
"email" : "...",
"displayName" : "...",
"lastSuccessfulFullBackupSize" : 12345,
"locked" : true,
"warningsPresent" : true,
"beingDeleted" : true,
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"externalSourceId" : "...",
"cloudServiceProvider" : {
"guid" : "...",
"cloudServiceProviderType" : "MICROSOFT365",
"name" : "...",
"tenantId" : "...",
"applications" : [ {
"guid" : "...",
"clientId" : "...",
"clientSecret" : "...",
"secretChanged" : true
}, {
"guid" : "...",
"clientId" : "...",
"clientSecret" : "...",
"secretChanged" : true
} ],
"possibleActions" : [ "WRITE", "HVM_READ" ],
"nodeConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"filterUser" : {
"usageLocation" : [ "...", "..." ],
"country" : [ "...", "..." ],
"officeLocation" : [ "...", "..." ]
}
},
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"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_ONLY",
"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
},
"averageProgress" : 12345.0,
"lastChainMarkedForDeletion" : true,
"present" : true,
"userPurpose" : "SHARED",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"totalBackupSize" : 12345,
"lastBackup" : 1451649601000
}
Returns list of subsites of the site.
name | type | description |
---|---|---|
guid | path | specify guid of site |
media type | data type | description |
---|---|---|
application/json | array of CloudSiteListEntry (JSON) | list of subsites |
GET /cloud-protected-entities/site/{guid}/subsites
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"externalSourceId" : "...",
"groupGuid" : "...",
"displayName" : "...",
"accessLevel" : "...",
"siteType" : "...",
"status" : "...",
"address" : "...",
"locked" : true,
"cloudServiceProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"type" : "OS_AGENT",
"parent" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"present" : true
} ]
name | type | description |
---|---|---|
guid | path | |
protectedEntityType | path |
media type | data type | description |
---|---|---|
application/json | CloudUserAvailableFeaturesForRestore (JSON) |
GET /cloud-protected-entities/{protectedEntityType}/{guid}/get-available-features-for-restore
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"featuresToRestore" : {
"property1" : true,
"property2" : true
}
}
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 /cloud-protected-entities/{protectedEntityType}/{guid}/storage-usage
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"allUsedSPConfigs" : [ "...", "..." ],
"usedSPConfigsForLastVersions" : [ "...", "..." ]
}
Returns container folder for features
name | type | description |
---|---|---|
guid | path | specify guid of protected entity |
protectedEntityType | path | specify type of protected entity |
tab | path | tab name for feature |
media type | data type | description |
---|---|---|
application/json | array of CloudProtectedObjectDetailsForUI (JSON) | protected entity |
GET /cloud-protected-entities/{protectedEntityType}/{guid}/{tab}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"type" : "ARCHIVE_DIRECTORY",
"deleted" : true,
"directory" : "...",
"name" : "...",
"displayName" : "...",
"parent" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"protectedEntity" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"protectedEntityType" : "CLOUD_GROUP",
"externalSourceId" : "...",
"newExternalSourceId" : "...",
"lastVersion" : {
"guid" : "...",
"displayName" : "...",
"fileSize" : 12345,
"creationDate" : 12345,
"lastWriteDate" : 12345,
"deleted" : true,
"metadata" : { },
"quickXorHash" : "...",
"verificationStatus" : "OK",
"spConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
},
"versions" : [ {
"guid" : "...",
"displayName" : "...",
"fileSize" : 12345,
"creationDate" : 12345,
"lastWriteDate" : 12345,
"deleted" : true,
"metadata" : { },
"quickXorHash" : "...",
"verificationStatus" : "FIXED",
"spConfig" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}, {
"guid" : "...",
"displayName" : "...",
"fileSize" : 12345,
"creationDate" : 12345,
"lastWriteDate" : 12345,
"deleted" : true,
"metadata" : { },
"quickXorHash" : "...",
"verificationStatus" : "NOT_VERIFIED",
"spConfig" : {
"guid" : "...",
"name" : "..."
}
} ]
} ]