Cloud Protected Object Controller Resource

The API allows you to list and view cloud protected objects.

GET /cloud-protected-objects/{objectGuid}

Returns protected object metadata.

Request Parameters
name type description constraints
objectGuid path protected object guid  
guid query  
tab query  
type query "APP" or "CLOUD" or "CLOUD_GROUP" or "CLOUD_SITE" or "CLOUD_TEAMS" or "CLOUD_USER" or "OS" or "OS_AGENT" or "STORAGE" or "VM"
Response Body
media type data type description
application/json CloudProtectedObjectDetailsForUI (JSON) protected object details

Example

Request
GET /cloud-protected-objects/{objectGuid}
Content-Type: */*
Accept: application/json

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

                
{
  "guid" : "...",
  "type" : "TEAMS_CHANNEL_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_TEAMS",
  "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" : "FIXED",
    "spConfig" : {
      "guid" : "...",
      "name" : "..."
    }
  } ]
}
                
              

GET /cloud-protected-objects/{objectGuid}/children

Returns list of protected object children metadata (objects in directory).

Request Parameters
name type description default constraints
objectGuid path protected object guid    
calendarFrom query   long
calendarTo query   long
deleted query   required
direction query    
filter query    
from query   long
guid query    
orderBy query    
page query 0 long
pointInTime query   long
size query 99999999 long
tab query    
to query   long
type query   "APP" or "CLOUD" or "CLOUD_GROUP" or "CLOUD_SITE" or "CLOUD_TEAMS" or "CLOUD_USER" or "OS" or "OS_AGENT" or "STORAGE" or "VM"
Response Body
media type data type description
application/json CloudProtectedObjectsDetailsForUI (JSON) list of protected object details

Example

Request
GET /cloud-protected-objects/{objectGuid}/children
Content-Type: */*
Accept: application/json

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

                
{
  "cloudProtectedObjectDetailsList" : [ {
    "guid" : "...",
    "type" : "ARCHIVE_EMAIL",
    "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" : { }
    },
    "versions" : [ {
      "guid" : "...",
      "displayName" : "...",
      "fileSize" : 12345,
      "creationDate" : 12345,
      "lastWriteDate" : 12345,
      "deleted" : true,
      "metadata" : { },
      "quickXorHash" : "...",
      "verificationStatus" : "OK",
      "spConfig" : { }
    }, {
      "guid" : "...",
      "displayName" : "...",
      "fileSize" : 12345,
      "creationDate" : 12345,
      "lastWriteDate" : 12345,
      "deleted" : true,
      "metadata" : { },
      "quickXorHash" : "...",
      "verificationStatus" : "OK",
      "spConfig" : { }
    } ]
  }, {
    "guid" : "...",
    "type" : "DIRECTORY",
    "deleted" : true,
    "directory" : "...",
    "name" : "...",
    "displayName" : "...",
    "parent" : {
      "guid" : "...",
      "name" : "..."
    },
    "protectedEntity" : {
      "guid" : "...",
      "name" : "..."
    },
    "protectedEntityType" : "STORAGE",
    "externalSourceId" : "...",
    "newExternalSourceId" : "...",
    "lastVersion" : {
      "guid" : "...",
      "displayName" : "...",
      "fileSize" : 12345,
      "creationDate" : 12345,
      "lastWriteDate" : 12345,
      "deleted" : true,
      "metadata" : { },
      "quickXorHash" : "...",
      "verificationStatus" : "NOT_VERIFIED",
      "spConfig" : { }
    },
    "versions" : [ {
      "guid" : "...",
      "displayName" : "...",
      "fileSize" : 12345,
      "creationDate" : 12345,
      "lastWriteDate" : 12345,
      "deleted" : true,
      "metadata" : { },
      "quickXorHash" : "...",
      "verificationStatus" : "NOT_VERIFIED",
      "spConfig" : { }
    }, {
      "guid" : "...",
      "displayName" : "...",
      "fileSize" : 12345,
      "creationDate" : 12345,
      "lastWriteDate" : 12345,
      "deleted" : true,
      "metadata" : { },
      "quickXorHash" : "...",
      "verificationStatus" : "OK",
      "spConfig" : { }
    } ]
  } ],
  "chatMembersForUI" : [ "...", "..." ]
}
                
              

GET /cloud-protected-objects/{objectGuid}/preview

Returns preview of protected object.

Request Parameters
name type description constraints
objectGuid path specify guid of protected object  
guid query  
tab query  
type query "APP" or "CLOUD" or "CLOUD_GROUP" or "CLOUD_SITE" or "CLOUD_TEAMS" or "CLOUD_USER" or "OS" or "OS_AGENT" or "STORAGE" or "VM"
Response Body
media type data type description
application/json string (JSON) preview of protected object

Example

Request
GET /cloud-protected-objects/{objectGuid}/preview
Content-Type: */*
Accept: application/json

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

                
...