Getting StartedAPI ReferenceRecipesGitHub
API Reference

List Objects.

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

Privileges: OBJECT_SEARCH

List objects.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Specifies the search string to filter the objects. This search string will be applicable for objectnames. User can specify a wildcard character '' as a suffix to a string where all object 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 will be returned which will match other filtering criteria.

environments
array of strings

Specifies the environment type to filter objects.

protectionTypes
array of strings

Specifies the protection type to filter objects.

tenantIds
array of strings

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

tenantIds
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
osTypes
array of strings

Specifies the operating system types to filter objects on.

osTypes
o365ObjectTypes
array of strings

Specifies the object types to filter objects on. Only applicable if the environment is o365.

o365ObjectTypes
azureObjectTypes
array of strings

Specifies the object types to filter objects on. Only applicable if the environment is Azure.

azureObjectTypes
awsObjectTypes
array of strings

Specifies the object types to filter objects on. Only applicable if the environment is AWS.

awsObjectTypes
azureUuids
array of strings

Specifies the Azure UUID for the Microsoft365 objects. If specified, the objects with the matching Azure UUIDs will be returned.

azureUuids
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
sourceUuids
array of strings

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

sourceUuids
objectUuids
array of strings

Specifies a list of object uuids to filter the object, based on the object uuid. These uuid are vendor specific and should be of the form, <sourceUuid_uuid>.

objectUuids
boolean

Specifies the protection status of objects. If set to true, only protected objects will be returned. If set to false, only unprotected objects will be returned. If not specified, all objects will be returned.

boolean

If set to true, then objects which are deleted on atleast one cluster will be returned. If not set or set to false then objects which are registered on atleast one cluster are returned.

boolean

If set to true, then only the objects which are deleted on atleast one cluster will be returned.

lastRunStatusList
array of strings

Specifies a list of status of the object's last protection run. Only objects with last run status of these will be returned.

lastRunStatusList
regionIds
array of strings

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

regionIds
clusterIdentifiers
array of strings

Specifies the list of cluster identifiers. Format is clusterId:clusterIncarnationId. Only records from clusters having these identifiers will be returned.

clusterIdentifiers
storageDomainIds
array of strings

Specifies the list of storage domain ids. Format is clusterId:clusterIncarnationId:storageDomainId. Only objects having protection in these storage domains will be returned.

storageDomainIds
boolean

Specifies whether to include deleted objects in response. These objects can't be protected but can be recovered. This field is deprecated.

string

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

int32

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

mustHaveTagIds
array of strings

Specifies tags which must be all present in the document.

mustHaveTagIds
mightHaveTagIds
array of strings

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

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

mustHaveSnapshotTagIds
mightHaveSnapshotTagIds
array of strings

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
string

Specifies the tag name to filter the tagged objects and snapshots. User can specify a wildcard character '*' as a suffix to a string where all object's tag names are matched with the prefix string.

tagNames
array of strings

Specifies the tag names to filter the tagged objects and snapshots only for non system tags

tagNames
anomalyTags
array of strings

Specifies the Anomaly's tag names to filter the tagged snapshots

anomalyTags
dataClassificationTags
array of strings

Specifies the Data classification's tag names to filter the tagged snapshots

dataClassificationTags
threatTags
array of strings

Specifies the threat tag's names to filter the tagged snapshots

threatTags
tagNamesExcluded
array of strings

Specifies the tag names to not include in the tagged snapshots response

tagNamesExcluded
tagTypes
array of strings

Specifies the tag type to filter the objects and snapshots.

tagTypes
tagCategories
array of strings

Specifies the tag category to filter the objects and snapshots.

tagCategories
tagSubCategories
array of strings

Specifies the tag subcategory to filter the objects and snapshots

tagSubCategories
boolean

Specifies whether to include helios tags information for objects in response. Default value is false

externalFilters
array of strings

Specifies the key-value pairs to filtering the results for the search. Each filter is of the form 'key:value'. The filter 'externalFilters:k1:v1&externalFilters:k2:v2&externalFilters:k2:v3' returns the documents where each document will match the query (k1=v1) AND (k2=v2 OR k2 = v3). Allowed keys: - vmBiosUuid - graphUuid - arn - instanceId - bucketName - azureId

externalFilters
Headers
string
enum

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

Allowed:
Responses

Updated 3 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago