Get Objects.

get

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

Privileges: PROTECTION_VIEW

Get Objects Configurations.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids

array of int64s

Filter by a list of Object ids. Only one of ids or globalIds should be used.

ids

objectActionKeys

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. The vec's size needs to be of either length one or same as the length of 'ids'. If the length of objectActionKey is one, it will be repeated as many number of times equal to the length of objectIds, as mandated by backend validation. If the length of objectActionKey and object ids are same then it will be passed as it is.

objectActionKeys

policyIds

array of strings

Filter by Policy ids that are associated with Protected Objects.

policyIds

parentId

int64

Filter by Parent Id. Parent id is a unique object Id which may contain protected objects underneath in the source tree.

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

globalIds

array of strings

Unique id to uniquely identify an object across clusters, if the same object is present on multiple clusters. For example, in case of a replication workflow, the object could be present on both local and remote cluster. In such scenarios, using the globalId, information about the object can be collected across the clusters. This is also applicable when object gets mapped to another cluster during tenant migration. Only one of ids or globalIds should be used.

globalIds

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.

regionIds

array of strings

Filter by a list of region ids.

regionIds

maxCount

int32

Specifies the max number of objects to return.

string

Specifies the pagination cookie.

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