List Domains (View Boxes) filtered by the specified parameters.

get

https://cluster.ip.address/irisservices/api/v1/public/viewBoxes

Privileges: STORAGE_DOMAIN_VIEW

If no parameters are specified, all Domains (View Boxes) currently on
the Cohesity Cluster are returned.
Specifying parameters filters the results that are returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

tenantIds

array of strings

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

tenantIds

allUnderHierarchy

boolean

AllUnderHierarchy specifies if objects of all the tenants under the
hierarchy of the logged in user's organization should be returned.

ids

array of int64s

Filter by a list of Storage Domain (View Box) ids.
If empty, View Boxes are not filtered by id.

ids

names

array of strings

Filter by a list of Storage Domain (View Box) Names.
If empty, Storage Domains (View Boxes) are not filtered by Name.

names

clusterPartitionIds

array of int64s

Filter by a list of Cluster Partition Ids.

clusterPartitionIds

fetchStats

boolean

Specifies whether to include usage and performance statistics.

fetchTimeSeriesSchema

boolean

Specifies whether to get time series schema info of the view box.

templateId

int64

Filter list of Storage Domain (View Box) by the properties of the template
like dedup, compression.
If empty, Storage Domains (View Boxes) are not filtered.

matchPartialNames

boolean

If true, the names in 'names' field are matched by prefix rather than
exactly matched.

purpose

array of strings

Filter by Storage Domain purpose.

purpose

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