Find backup objects that match the specified search and filter criteria on the Cohesity Cluster.

get

https://cluster.ip.address/irisservices/api/v1/public/restore/objects

Privileges: RESTORE_VIEW

If no search pattern or filter parameters are specified, all backup objects
currently found on the Cohesity Cluster are returned.
Only leaf objects that have been protected by a Job are returned such as VMs,
Views and databases.
Specify a search pattern or parameters to filter the results that
are returned.

The term "items" below refers to leaf backup objects such as VMs,
Views and databases.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Filter by searching for sub-strings in the item name. The specified
string can match any part of the item name.
For example: "vm" or "123" both match the item name of "vm-123".

jobIds

array of int64s

Filter by a list of Protection Job ids.
Only items backed up by the specified Jobs are listed.

jobIds

registeredSourceIds

array of int64s

Filter by a list of Registered Sources ids. Only items
from the listed Registered Sources are returned.

registeredSourceIds

viewBoxIds

array of int64s

Filter by a list of Domains (View Boxes) ids.
Only items stored in the listed Domains (View Boxes) are returned.

viewBoxIds

environments

array of strings

Filter by environment types such as 'kVMware', 'kView', etc.
Only items from the specified environment types are returned.
NOTE: 'kPuppeteer' refers to Cohesity's Remote Adapter.

environments

office365SourceTypes

array of strings

Filter by Office365 types such as 'kUser', 'kSite', etc.
Only items from the specified source types are returned.

office365SourceTypes

startTimeUsecs

int64

Filter by backup completion time by specifying a backup
completion start and end times. Specified as a Unix epoch
Timestamp (in microseconds).
Only items created by backups that completed between the
specified start and end times are returned.

endTimeUsecs

int64

Filter by backup completion time by specify a backup
completion start and end times. Specified as a Unix epoch
Timestamp (in microseconds).
Only items created by backups that completed between the
specified start and end times are returned.

startIndex

int64

Specifies an index number that can be used to return subsets of items
in multiple requests.
Break up the items to return into multiple requests
by setting pageCount and using startIndex to return a subsets of items.
For example, set startIndex to 0 to get the first set of items
for the first request. Increment startIndex by pageCount
to get the next set of items for a next request.
Continue until all items are returned and therefore the total number of
returned items is equal to totalCount.

pageCount

int64

Limit the number of items to return in the response for pagination
purposes.

operatingSystems

array of strings

Filter by the Operating Systems running on VMs and Physical Servers.
This filter is applicable only to VMs and physical servers.

operatingSystems

application

string

Filter by application when the environment type is kSQL.
For example, if SQL is specified the SQL databases are returned.

ownerEntityId

int64

Filter objects by the Entity id of the owner VM. For example, if a
ownerEntityId is provided while searching for SQL databases,
only SQL databases belonging to the VM with the specified id
are returned.
ownerEntityId is only significant if application is set to SQL.

tenantId

string

TenantId specifies the tenant whose action resulted in the audit log.

allUnderHierarchy

boolean

AllUnderHierarchy specifies if logs of all the tenants under the hierarchy
of tenant with id TenantId should be returned.

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