List Views filtered by some parameters.

get

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

Privileges: STORAGE_VIEW

If no parameters are specified, all Views on the Cohesity Cluster are returned.
Specifying parameters filters the results that are returned.
NOTE: If maxCount is set and the number of Views returned exceeds the maxCount,
there are more Views to return.
To get the next set of Views, send another request and specify the id of the
last View returned in viewList from the previous response.

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.

viewNames

array of strings

Filter by a list of View names.

viewNames

viewIds

array of int64s

Filter by a list of View ids.

viewIds

viewBoxIds

array of int64s

Filter by a list of Storage Domains (View Boxes) specified by id.

viewBoxIds

viewBoxNames

array of strings

Filter by a list of View Box names.

viewBoxNames

matchPartialNames

boolean

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

maxCount

int32

Specifies a limit on the number of Views returned.

includeProtectionJobs

boolean

Specifies if Protection Jobs information needs to be returned along with
view metadata. By default, if not set or set to true, Job information is
returned.

maxViewId

int64

If the number of Views to return exceeds the maxCount specified in the
original request, specify the id of the last View
from the viewList in the previous response
to get the next set of Views.

includeInactive

boolean

Specifies if inactive Views on this Remote Cluster (which have
Snapshots copied by replication) should also be returned.
Inactive Views are not counted towards the maxCount.
By default, this field is set to false.

jobIds

array of int64s

Filter by Protection Job ids. Return Views that are being protected by
listed Jobs, which are specified by ids.

jobIds

SortByLogicalUsage

boolean

If set to true, the list is sorted descending by logical usage.

matchAliasNames

boolean

If true, view aliases are also matched with the names in viewNames.

includeViewsWithAntivirusEnabledOnly

boolean

If set to true, the list will contain only the views for which antivirus
scan is enabled.

includeStats

boolean

If set to true, stats of views will be returned. By default this parameter
is set to false.

includeViewsWithDataLockEnabledOnly

boolean

If set to true, the list will contain only the views for which either
file level data lock is enabled or view level data lock is enabled.

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