List Protected Objects.

get

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

Privileges: RESTORE_VIEW

List protected objects and corresponding detail information from registered sources filtered by specified query parameters. If no search pattern or filter parameters are specified, all protected objects currently found are returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

searchString

string

Specifies the search string to filter the objects. This search string will be applicable for objectnames and Protection Group names. User can specify a wildcard character '' as a suffix to a string where all object and their Protection Group names are matched with the prefix string. For example, if vm1 and vm2 are the names of objects, user can specify vm to list the objects. If not specified, then all the objects with Protection Groups will be returned which will match other filtering criteria.

environments

array of strings

Specifies the environment type to filter objects.

snapshotActions

array of strings

Specifies a list of recovery actions. Only snapshots that applies to these actions will be returned.

objectActionKey

string

enum

Filter by ObjectActionKey, which uniquely represents protection of an object. An object can be protected in multiple ways but atmost once for a given combination of ObjectActionKey. When specified, latest snapshot info matching the objectActionKey is for corresponding object.

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 belongs to all tenants which the current user has permission to see.

protectionGroupIds

array of strings

Specifies a list of Protection Group ids to filter the objects. If specified, the objects protected by specified Protection Group ids will be returned.

protectionGroupIds

objectIds

array of int64s

Specifies a list of Object ids to filter.

objectIds

storageDomainIds

array of int64s

Specifies the Storage Domain ids to filter objects for which Protection Groups are writing data to Cohesity Views on the specified Storage Domains.

storageDomainIds

subResultSize

int32

Specifies the size of objects to be fetched for a single subresult.

filterSnapshotFromUsecs

int64

Specifies the timestamp in Unix time epoch in microseconds to filter the objects if the Object has a successful snapshot after this value.

filterSnapshotToUsecs

int64

Specifies the timestamp in Unix time epoch in microseconds to filter the objects if the Object has a successful snapshot before this value.

osTypes

array of strings

Specifies the operating system types to filter objects on.

osTypes

sourceIds

array of int64s

Specifies a list of Protection Source object ids to filter the objects. If specified, the object which are present in those Sources will be returned.

sourceIds

runInstanceIds

array of int64s

Specifies a list of run instance ids. If specified only objects belonging to the provided run id will be retunrned.

runInstanceIds

cdpProtectedOnly

boolean

Specifies whether to only return the CDP protected objects.

regionIds

array of strings

Specifies a list of region ids. Only records from clusters having these region ids will be returned.

regionIds

useCachedData

boolean

Specifies whether we can serve the GET request to the read replica cache cache. There is a lag of 15 seconds between the read replica and primary data source.

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