OS Protected Entity Controller Resource

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

GET /os-protected-entities/{protectedEntityType}

Returns list of protected entity by type.

Request Parameters
name type description
protectedEntityType path specify type of protected entity
Response Body
media type data type description
application/json array of OSProtectedEntityDetails (JSON) list of protected entities

Example

Request
GET /os-protected-entities/{protectedEntityType}
Content-Type: */*
Accept: application/json

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

                
[ {
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000
} ]

GET /os-protected-entities/{protectedEntityType}/{guid}

Returns details of protected entity by type and guid.

Request Parameters
name type description
guid path specify guid of protected entity
protectedEntityType path specify type of protected entity
Response Body
media type data type description
application/json OSProtectedEntityDetails (JSON) protected entity

Example

Request
GET /os-protected-entities/{protectedEntityType}/{guid}
Content-Type: */*
Accept: application/json

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

                
{
  "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
  "lastBackup" : 1451649601000
}

GET /os-protected-entities/{protectedEntityType}/{guid}/storage-usage

Returns storage usage of protected entity by type and guid.

Request Parameters
name type description
guid path specify guid of protected entity
protectedEntityType path specify type of protected entity
Response Body
media type data type description
application/json StorageUsage (JSON) storage usage of protected entity

Example

Request
GET /os-protected-entities/{protectedEntityType}/{guid}/storage-usage
Content-Type: */*
Accept: application/json

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

                
{ }