OS Protected Object Controller Resource

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

GET /os-protected-objects/root

Returns root of protected objects.

Request Parameters
name type description constraints
peGuid query  
peType 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"
roleType query "ARCHIVE" or "PRIMARY" or "SECONDARY"
Response Body
media type data type description
application/json OSProtectedObjectDetailsForUI (JSON) root object details

Example

Request
GET /os-protected-objects/root
Content-Type: */*
Accept: application/json

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

                
{ }

GET /os-protected-objects/{objectGuid}/all-versions

Returns list of protected object versions

Request Parameters
name type description constraints
objectGuid path protected object guid  
deleted query required boolean
direction query  
filter query  
filterObjects query "ONLY_DIRECTORIES" or "ONLY_FILES"
from query long
nameLike query  
orderBy query  
page query  
peGuid query  
peType 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"
roleType query "ARCHIVE" or "PRIMARY" or "SECONDARY"
size query  
to query long
Response Body
media type data type description
application/json array of OSProtectedObjectVersionDetailsForUI (JSON) list of protected object versions

Example

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

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

                
[ { } ]

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

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

Request Parameters
name type description constraints
objectGuid path protected object guid  
deleted query required boolean
direction query  
filter query  
filterObjects query "ONLY_DIRECTORIES" or "ONLY_FILES"
from query long
nameLike query  
orderBy query  
page query  
peGuid query  
peType 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"
roleType query "ARCHIVE" or "PRIMARY" or "SECONDARY"
size query  
to query long
Response Body
media type data type description
application/json array of OSProtectedObjectDetailsForUI (JSON) list of protected object details

Example

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

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

                
[ { } ]

GET /os-protected-objects/{objectGuid}/children-v2

Returns list of protected object children metadata (objects in directory). This endpoint contains performance fix

Request Parameters
name type description constraints
objectGuid path protected object guid  
deleted query required boolean
direction query  
filter query  
filterObjects query "ONLY_DIRECTORIES" or "ONLY_FILES"
from query long
nameLike query  
orderBy query  
page query  
peGuid query  
peType 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"
roleType query "ARCHIVE" or "PRIMARY" or "SECONDARY"
size query  
to query long
Response Body
media type data type description
application/json array of OSProtectedObjectDetailsDto (JSON) list of protected object details dto

Example

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

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

                
[ { } ]