AccessToken
- Create a new API access tokenpost
ActiveDirectory
Alert
AntivirusService
User
AthenaAppOps
- Relaunch app instanceput
- Relaunch System Appput
App
AuditLog
CohesityCA
Platform
Security
CloudResourceConfig
- Download Cloud Resource Config Template.get
Tenant
Config
- Get SNMP configuration.get
ConnectorAgent
DataAccessor
HeliosTagging
Object
Agent
CloudDomain
- /data-protect/attach-cloud-domainpost
ExternalTarget
Failover
ProtectionGroup
Policy
ProtectedObject
Recovery
RecoveryScan
CloudRetrieveTask
Search
Source
Templates
- Download the azure resource template.get
DataSourceConnection
DataSourceConnectorLocal
DataSourceConnector
DataTiering
MFA
View
FleetInstance
FortknoxOnprem
health
- Get Health Statusget
Registration
- Register to Helios.post
- Lists the Helios Registration Config.get
IdentityProvider
KerberosProvider
Keystone
KeyManagementSystem
LDAP
LSU
Firewall
Routes
NodeGroup
Privilege
- Get Privileges.get
RemoteClusters
RemoteStorage
Role
CertificateStore
SnmpConfig
- Get Snmp Configget
- Update Snmp Configput
Stats
StorageDomain
Support
Syslog
Tag
TenantDeactivation
- /tenants/deactivationspost
- /tenants/{id}/deactivationpost
Certificates
- Get the Server Certificate configured on the Cluster.get

AccessTokens
- Generate an Access Token.post
ActiveDirectory
Alerts
Analytics
AntivirusServiceGroup
AppInstance
App
Audit
Banner
- List the banner for a persona.get
- Update an existing banner on the Cohesity Cluster.put
Cluster
Vlan
Certificates
Clusters
ClusterPartitions
- List Cluster Partitions filtered by the specified parameters.get
- List details about a single Cluster Partition.get
Dashboard
- Returns the dashboard that match the filter criteria specified using parameters.get
Nodes
Groups
Idps
Interface
- Show network interfaces.get
- Update an interface.put
InterfaceGroup
Ip
- Delete the specified IP settings on the Cohesity Cluster.del
- Configure the specfied IP settings on the Cohesity Cluster.put
KmsConfiguration
GetKMSStatusResponse
- Returns the status of the KMS Server.get
LdapProvider
LicenseAgreement
- Accepts license agreement.post
Monitoring
Network
Views
Packages
ProtectionSources
CustomReporting
- List the postgres database running nodes on the cohesity cluster.get
Principals
Privileges
- List the privileges defined on the Cohesity Cluster.get
ProtectionJobs
ProtectionObjects
ProtectionPolicies
ProtectionRuns
RemoteCluster
RemoteRestore
Reports
RestoreTasks
CloneRefreshTasks
- Create a Clone Refresh Task to refresh the clone with the new data.post
Roles
Routes
Scheduler
Search
- /public/search/protectionRunsget
- Performs search on all the objects which are registered to a cluster.get
Notifications
- List the notification of the session user.get
- Perform operations on the notification of the session user.patch
Preferences
SMBFileOpens
- List the active SMB file opens that match the filter criteria specified using parameters.get
- Closes an active SMB file open.post
Statistics
Stats
Tags
- Apply Tags on existing objects in the Cohesity Cluster.put
- Remove Tags on existing objects in the Cohesity Cluster.put
Tenant
Vaults
ViewBoxes

Lists the entities for the specified schema.

get

https://cluster.ip.address/irisservices/api/v1/public/statistics/entities

Privileges: CLUSTER_VIEW

An entity is an object found on the Cohesity Cluster, such as a disk or a
Node.
In the Cohesity Dashboard, similar functionality is provided in Advanced
Diagnostics.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

schemaName

string

required

Specifies the entity schema to search for entities.

includeAggrMetricSources

boolean

Specifies whether to include the sources of aggregate metrics of an
entity.

metricNames

array of strings

Specifies the list of metric names to return such as 'kRandomIos'
which corresponds to 'Random IOs' in Advanced Diagnostics
of the Cohesity Dashboard.

metricNames

maxEntities

int32

Specifies the maximum entities returned in the result.
By default this field is 500.

viewName

string

Specifies a view name, only view entities which have name containing the
specified name will be returned.

entityPrefix

string

Fetch only the entities having this prefix, otherwise all entities are
returned.

filterCriteria

string

Specifies a FIQL filter criteria to filter the entities.

Responses

Updated about 6 hours ago

Closes an active SMB file open.

List the entity schemas filtered by the specified parameters.

Did this page help you?

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 6 hours ago

Closes an active SMB file open.

List the entity schemas filtered by the specified parameters.

Did this page help you?

200Success

defaultError