Get an Object.

get

https://cluster.ip.address/v2/data-protect/objects/{id}

Get Object configurations for given object id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specifies the id of the Object.

Query Params

objectActionKey

array of strings

Filter by ObjectActionKey, uniquely represent protection of an object. An object can be protected in multiple ways but atmost once for a given combination of ObjectActionKey, when specified Only objects of given action_key are returned for corresponding object id and this vec's size needs to be same as 'id'.

objectActionKey

onlyProtectedObjects

boolean

If true, the response will include only objects which have been protected.

storageDomainId

int64

Filter by Storage Domain id. Only Objects protected to this Storage Domain will be returned.

environments

array of strings

Filter by environment types such as 'kVMware', 'kView', etc. Only Protected objects protecting the specified environment types are returned.

environments

tenantIds

array of strings

TenantIds contains ids of the tenants for which objects are to be returned.

tenantIds

includeTenants

boolean

If true, the response will include Objects which were protected by all tenants which the current user has permission to see. If false, then only objects protected by the current user will be returned.

includeLastRunInfo

boolean

If true, the response will include information about the last protection run on this object.

onlyAutoProtectedObjects

boolean

If true, the response will include only the auto protected objects.

onlyLeafObjects

boolean

If true, the response will include only the leaf level objects.

Headers

requestInitiatorType

string

enum

Specifies the type of request from UI, which is used for services like magneto to determine the priority of requests.

Allowed:

Responses

200Success

defaultError