The API allows you to list and view cloud users.
Returns list of cloud users filtered by specified query parameters.
name | type | description | constraints | multivalued |
---|---|---|---|---|
backupStatus | query | "IS_PROTECTED" or "NOT_PROTECTED" or "NO_SCHEDULE" | yes | |
cloud-service-provider | query | no | ||
direction | query | no | ||
filter | query | no | ||
nameLike | query | no | ||
orderBy | query | no | ||
page | query | no | ||
policy | query | yes | ||
size | query | no |
media type | data type | description |
---|---|---|
application/json | array of CloudUserListRecord (JSON) | list of cloud users filtered by specified query parameters |
GET /cloud-users
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"type" : "CLOUD_GROUP",
"backupUpToDate" : true,
"restorable" : true,
"email" : "...",
"lastSuccessfulBackupSize" : 12345,
"externalSourceId" : "...",
"lastSuccessfulFullBackupSize" : 12345,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"possibleActions" : [ "HV_READ", "HV_READ" ],
"warningsPresent" : true,
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"present" : true,
"cloudServiceProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"cloudServiceProviderType" : "MICROSOFT365",
"averageProgress" : 12345.0,
"userPurpose" : "USER",
"lastChainMarkedForDeletion" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"lastBackup" : 1451649601000
} ]
Assign users to specified policy (or unassign if policy is null)
media type | data type | description |
---|---|---|
application/json | ProtectedEntityBackupPolicyAssignmentRequest (JSON) | containing policy and users info |
POST /cloud-users/assign-backup-policy
Content-Type: application/json
{
"backupPolicy" : "...",
"protectedEntities" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
HTTP/1.1 201 Created
Returns list of protected entities for backup cleanup.
name | type | description |
---|---|---|
backup-destination | query |
media type | data type | description |
---|---|---|
application/json | array of CloudUserListRecord (JSON) | list of protected entities for backup cleanup |
GET /cloud-users/backup-cleanup
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"type" : "OS",
"backupUpToDate" : true,
"restorable" : true,
"email" : "...",
"lastSuccessfulBackupSize" : 12345,
"externalSourceId" : "...",
"lastSuccessfulFullBackupSize" : 12345,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"possibleActions" : [ "READ", "HVM_READ" ],
"warningsPresent" : true,
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"present" : true,
"cloudServiceProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"cloudServiceProviderType" : "MICROSOFT365",
"averageProgress" : 12345.0,
"userPurpose" : "USER",
"lastChainMarkedForDeletion" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"lastBackup" : 1451649601000
} ]
Returns list of cloud users 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 cloud users filtered by specified query parameters |
GET /cloud-users/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" : "PROJECT",
"checked" : true,
"lastLevel" : true,
"present" : true,
"entityType" : "...",
"childrenQueryType" : "..."
} ]
Get a single cloud user.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for cloud user (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | CloudUserDetails (JSON) | cloud user details |
GET /cloud-users/{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" : "SSL"
},
"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,
"email" : "...",
"warningsPresent" : true,
"externalSourceId" : "...",
"lastSuccessfulFullBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"userPurpose" : "ROOM",
"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
},
"lastSuccessfulIncBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"averageProgress" : 12345.0,
"cloudServiceProvider" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"lastChainMarkedForDeletion" : true,
"cloudServiceProviderType" : "MICROSOFT365",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"possibleActions" : [ "HV_READ", "READ" ],
"present" : true,
"lastBackup" : 1451649601000
}