List indexed objects.

post

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

Privileges: RESTORE_VIEW

List all the indexed objects like files and folders, emails, mailboxes etc., that match the specified search and filter criteria from protected objects.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies the parameters to search for indexed objects.

Specifies the request parameters to search for indexed objects.

count

int32 | null

Specifies the number of indexed objects to be fetched for the specified pagination cookie.

includeTenants

boolean | null

Defaults to false

If true, the response will include objects which belongs to all tenants which the current user has permission to see. Default value is false.

mightHaveSnapshotTagIds

array of strings | null, unique

Specifies list of snapshot tags, one or more of which might be
present in the document. These are OR'ed together and the resulting
criteria AND'ed with the rest of the query.

mightHaveSnapshotTagIds

mightHaveTagIds

array of strings | null, unique

Specifies list of tags, one or more of which might be present in the
document. These are OR'ed together and the resulting criteria AND'ed
with the rest of the query.

mightHaveTagIds

mustHaveSnapshotTagIds

array of strings | null, unique

Specifies snapshot tags which must be all present in the document.

mustHaveSnapshotTagIds

mustHaveTagIds

array of strings | null, unique

Specifies tags which must be all present in the document.

mustHaveTagIds

objectType

string

enum

required

Specifies the object type to be searched for.

paginationCookie

string | null

Specifies the pagination cookie with which subsequent parts of the response can be fetched.

protectionGroupIds

array of strings | null

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

protectionGroupIds

snapshotTags

array of strings

"This field is deprecated. Please use mightHaveSnapshotTagIds."

snapshotTags

storageDomainIds

array of int64s | null

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

storageDomainIds

tags

tenantId

string | null

TenantId contains id of the tenant for which objects are to be returned.

useCachedData

boolean | null

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

cassandraParams

object

Parameters required to search Cassandra on a cluster.

couchbaseParams

object

Parameters required to search CouchBase on a cluster.

emailParams

object | null

Specifies the parameters which are specific for searching emails and email folders.

exchangeParams

object | null

Specifies the parameters which are specific for searching Exchange mailboxes.

fileParams

object

Specifies the parameters which are specific for searching files and file folders.

hbaseParams

object

Parameters required to search Hbase on a cluster.

hdfsParams

object

Parameters required to search HDFS on a cluster.

hiveParams

object

Parameters required to search Hive on a cluster.

mongodbParams

object

Parameters required to search Mongo DB on a cluster.

msGroupsParams

object | null

Specifies the parameters which are specific for searching Microsoft365 Group items.

msTeamsParams

object | null

Specifies the parameters which are specific for searching Microsoft365 Teams items.

oneDriveParams

object | null

Specifies the parameters which are specific for searching files/folders in a document library in a OneDrive.

publicFolderParams

object | null

Specifies the parameters which are specific for searching Public folder items.

sfdcParams

object | null

Specifies the parameters which are specific for searching records related to a salesforce Object.

sharepointParams

object | null

Specifies the parameters which are specific for searching files/folders in a document library in a Sharepoint site.

udaParams

object | null

Specifies the parameters which are specific for searching Universal Data Adapter objects.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError