Cloud Groups Controller Resource

The API allows you to list and view cloud teams.

GET /cloud-groups

Returns list of cloud teams filtered by specified query parameters.

Request 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
teams-group query boolean no
Response Body
media type data type description
application/json array of CloudGroupListRecord (JSON) list of cloud groups filtered by specified query parameters

Example

Request
GET /cloud-groups
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "name" : "...",
  "type" : "APP",
  "possibleActions" : [ "READ", "HV_READ" ],
  "backupUpToDate" : true,
  "restorable" : true,
  "policy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulBackupSize" : 12345,
  "present" : true,
  "cloudServiceProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulFullBackupSize" : 12345,
  "cloudServiceProviderType" : "MICROSOFT365",
  "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
} ]
                
              

POST /cloud-groups/assign-backup-policy

Assign groups to specified policy (or unassign if policy is null)

Request Body
media type data type description
application/json ProtectedEntityBackupPolicyAssignmentRequest (JSON) containing policy and groups info

Example

Request
POST /cloud-groups/assign-backup-policy
Content-Type: application/json

                
{
  "backupPolicy" : "...",
  "protectedEntities" : [ {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  }, {
    "guid" : "...",
    "name" : "..."
  } ]
}
                
              
Response
HTTP/1.1 201 Created

              

GET /cloud-groups/backup-cleanup

Returns list of protected entities for backup cleanup.

Request Parameters
name type description
backup-destination query
Response Body
media type data type description
application/json array of CloudGroupListRecord (JSON) list of protected entities for backup cleanup

Example

Request
GET /cloud-groups/backup-cleanup
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "name" : "...",
  "type" : "VM",
  "possibleActions" : [ "HV_READ", "HV_READ" ],
  "backupUpToDate" : true,
  "restorable" : true,
  "policy" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulBackupSize" : 12345,
  "present" : true,
  "cloudServiceProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "lastSuccessfulFullBackupSize" : 12345,
  "cloudServiceProviderType" : "MICROSOFT365",
  "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
} ]
                
              

GET /cloud-groups/rbac-contexts

Returns list of cloud groups filtered by specified query parameters.

Request 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
Response Body
media type data type description
application/json array of RbacContextListRecord (JSON) list of cloud groups filtered by specified query parameters

Example

Request
GET /cloud-groups/rbac-contexts
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "nameAndGuid" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "uuid" : "...",
  "type" : "STORAGE_PROVIDER",
  "checked" : true,
  "lastLevel" : true,
  "present" : true,
  "entityType" : "...",
  "childrenQueryType" : "..."
} ]
                
              

GET /cloud-groups/{guid}

Get a single cloud group.

Request Parameters
name type description
guid path specify local unique identifier for cloud group (use by vProtect)
Response Body
media type data type description
application/json CloudGroupDetails (JSON) cloud group details

Example

Request
GET /cloud-groups/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
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" : "APP",
  "backupUpToDate" : true,
  "restorable" : true,
  "lastSuccessfulBackupSize" : 12345,
  "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
  },
  "lastSuccessfulFullBackupSize" : 12345,
  "cloudServiceProvider" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "warningsPresent" : true,
  "lastSuccessfulFullBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "cloudServiceProviderType" : "MICROSOFT365",
  "lastSuccessfulIncBackup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "externalSourceId" : "...",
  "averageProgress" : 12345.0,
  "siteExternalSourceId" : "...",
  "lastChainMarkedForDeletion" : true,
  "siteGuid" : "...",
  "teamsGroup" : true,
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "possibleActions" : [ "INVENTORY_SYNC", "WRITE" ],
  "present" : true,
  "members" : [ "...", "..." ],
  "lastBackup" : 1451649601000
}