List Views

get

https://helios.cohesity.com/v2/file-services/views

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

viewNames

array of strings

Filter by a list of View names.

viewNames

viewIds

array of int64s

Filter by a list of View ids.

viewIds

storageDomainIds

array of int64s

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

storageDomainIds

storageDomainNames

array of strings

Filter by a list of View Box names.

storageDomainNames

protocolAccesses

array of strings

Filter by a list of protocol accesses. Only views with protocol accesses in these specified accesses list will be returned.

protocolAccesses

matchPartialNames

boolean

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

maxCount

int32

Specifies a limit on the number of Views returned.

includeInternalViews

boolean

Specifies if internal Views created by the Cohesity Cluster are also returned. In addition, regular Views are returned.

skipHighIdViews

boolean

Specifies if Views with ID greater than BridgeConstants::kViewIdMangleMask should be returned. These Views are created by MagnetoV2 or NetBackup.

includeProtectionGroups

boolean

Specifies if Protection Groups information needs to be returned along with view metadata. By default, if not set or set to true, Group 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.

protectionGroupIds

array of int64s

This field will be deprecated. Filter by Protection Group ids. Return Views that are being protected by listed Groups, which are specified by ids. If both protectionGroupIds and viewProtectionGroupIds are specified, only viewProtectionGroupIds will be used.

protectionGroupIds

viewProtectionGroupIds

array of strings

Filter by Protection Group ids. Return Views that are being protected by listed Groups, which are specified by ids.

viewProtectionGroupIds

viewCountOnly

boolean

Whether to get just the total number of views with the given input filters. If the flag is true, we ignore the parameter 'maxViews' for the count. Also, if flag is true, list of views will not be returned.

summaryOnly

boolean

Whether to get only view summary including 'name', 'viewId', 'storageDomainName', 'storageDomainId' and 'tenantId'.

sortByLogicalUsage

boolean

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

internalAccessSids

array of strings

Sids of restricted principals who can access the view. This is an internal field and therefore does not have json tag.

internalAccessSids

matchAliasNames

boolean

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

tenantIds

array of strings

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

tenantIds

includeTenants

boolean

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

includeStats

boolean

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

includeFileCountBySize

boolean

Whether to include View file count by size.

includeViewsWithAntivirusEnabledOnly

boolean

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

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.

filerAuditLogEnabled

boolean

If set to true, only views with filer audit log enabled will be returned. If set to false, only views with filer audit log disabled will be returned.

categories

viewProtectionTypes

array of strings

Filter by a list of View protection types. Supported types: [Local Archival ReplicationOut ReplicationIn UnProtected]. UnProtected is mutually exclusive from remaining types.

viewProtectionTypes

lastRunAnyStatuses

array of strings

Filter by last any run status of the view.
'Running' indicates that the run is still running.
'Canceled' indicates that the run has been canceled.
'Canceling' indicates that the run is in the process of being canceled.
'Failed' indicates that the run has failed.
'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening.
'Succeeded' indicates that the run has finished successfully.
'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages.
'Skipped' indicates that the run was skipped.

lastRunAnyStatuses

lastRunLocalBackupStatuses

array of strings

Filter by last local backup run status of the view.
'Running' indicates that the run is still running.
'Canceled' indicates that the run has been canceled.
'Canceling' indicates that the run is in the process of being canceled.
'Failed' indicates that the run has failed.
'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening.
'Succeeded' indicates that the run has finished successfully.
'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages.
'Skipped' indicates that the run was skipped.

lastRunLocalBackupStatuses

lastRunReplicationStatuses

array of strings

Filter by last remote replication run status of the view.
'Running' indicates that the run is still running.
'Canceled' indicates that the run has been canceled.
'Canceling' indicates that the run is in the process of being canceled.
'Failed' indicates that the run has failed.
'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening.
'Succeeded' indicates that the run has finished successfully.
'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages.
'Skipped' indicates that the run was skipped.

lastRunReplicationStatuses

lastRunArchivalStatuses

array of strings

Filter by last cloud archival run status of the view.
'Running' indicates that the run is still running.
'Canceled' indicates that the run has been canceled.
'Canceling' indicates that the run is in the process of being canceled.
'Failed' indicates that the run has failed.
'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening.
'Succeeded' indicates that the run has finished successfully.
'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages.
'Skipped' indicates that the run was skipped.

lastRunArchivalStatuses

isProtected

boolean

Specifies the protection status of Views. If set to true, only protected Views will be returned. If set to false, only unprotected Views will be returned.

qosPrincipalIds

array of int64s

qosPrincipalIds contains ids of the QoS principal for which views are to be returned. This field is deprecated.

qosPrincipalIds

qosPolicies

array of strings

Specifies a filter for Views based on the qosPolicies. This param will be prioritized if qosPrincipalIds is also specified.

qosPolicies

useCachedData

boolean

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

includeDeletedProtectionGroups

boolean

Specifies if deleted Protection Groups information needs to be returned along with view metadata. By default, deleted Protection Groups are not returned. This is only applied if used along with any view protection related parameter.

returnAllViews

boolean

Specifies if all the Views should be returned as part of the response.

includeS3MigrationOnly

boolean

Specifies whether to return only views which have a s3 migration state.

s3MigrationState

string

enum

Filter the list of Views by S3 Migration Statuses. Supported filter values are [Enabled, UnderMigration, Paused, Completed, Eligible]." If s3MigrationState is specified then includeS3MigrationOnly param should also be set to true.

Allowed:

Headers

accessClusterId

int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

200Success

defaultError