Get Shares.

get

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

If no parameters are specified, all shares on the Cohesity Cluster are returned. Specifying share name/prefix filters the results that are returned. NOTE: If maxCount is set and the number of Shares returned exceeds the maxCount, there are more Share to return. To get the next set of Views, send another request and specify the pagination cookie from the previous response. If maxCount is not specified, the first 2000 Shares.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Specifies the Share name.

isReadOnlyView

boolean

If true, only shares of Views that are Read-Only will be returned.

matchPartialName

boolean

If true, the share name is matched by any partial rather than exactly matched.

maxCount

int32

Specifies a limit on the number of Shares returned. If maxCount is not specified, the first 2000 Shares.

string

Specifies the pagination cookie. Expected to be empty in the first call to the API. To get the next set of results, set this value to the pagination cookie value returned in the response of the previous call.

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.

Headers

accessClusterId

int64

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

Responses

200Success

defaultError