The API allows you to list and view os protected objects.
Returns root of protected objects.
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" |
media type | data type | description |
---|---|---|
application/json | OSProtectedObjectDetailsForUI (JSON) | root object details |
GET /os-protected-objects/root
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guid" : "...",
"type" : "ROOT",
"name" : "...",
"parentGuid" : "...",
"deleted" : true,
"lastVersion" : {
"guid" : "...",
"fileSize" : 12345,
"backupTime" : 12345,
"modificationTime" : 12345,
"deleted" : true
},
"versions" : [ {
"guid" : "...",
"fileSize" : 12345,
"backupTime" : 12345,
"modificationTime" : 12345,
"deleted" : true
}, {
"guid" : "...",
"fileSize" : 12345,
"backupTime" : 12345,
"modificationTime" : 12345,
"deleted" : true
} ]
}
Returns list of protected object children metadata (objects in directory).
name | type | description | constraints |
---|---|---|---|
objectGuid | path | protected object guid | |
deleted | query | required | |
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" | |
size | query | ||
to | query | long |
media type | data type | description |
---|---|---|
application/json | array of OSProtectedObjectDetailsForUI (JSON) | list of protected object details |
GET /os-protected-objects/{objectGuid}/children
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"type" : "DIRECTORY",
"name" : "...",
"parentGuid" : "...",
"deleted" : true,
"lastVersion" : {
"guid" : "...",
"fileSize" : 12345,
"backupTime" : 12345,
"modificationTime" : 12345,
"deleted" : true
},
"versions" : [ {
"guid" : "...",
"fileSize" : 12345,
"backupTime" : 12345,
"modificationTime" : 12345,
"deleted" : true
}, {
"guid" : "...",
"fileSize" : 12345,
"backupTime" : 12345,
"modificationTime" : 12345,
"deleted" : true
} ]
} ]