/public/reports/agents

get

https://cluster.ip.address/irisservices/api/v1/public/reports/agents

Privileges: REPORTS_VIEW

Get the list of all the installed agents which includes the health status and
upgradability of the agent.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

hostOsType

array of strings

Specifies the host type on which the Cohesity agent is installed.
Setting this parameter will filter the response based on host OS type on
which agent is running.
'kLinux' indicates the Linux operating system.
'kWindows' indicates the Microsoft Windows operating system.
'kAix' indicates the IBM AIX operating system.
'kSolaris' indicates the Oracle Solaris operating system.
'kSapHana' indicates the Sap Hana database system developed by SAP SE.
'kSapOracle' indicates the Sap Oracle database system developed by SAP SE.
'kCockroachDB' indicates the CockroachDB database system.
'kMySQL' indicates the MySQL database system.
'kSapSybase' indicates the SapSybase database system.
'kSapMaxDB' indicates the SapMaxDB database system.
'kSapSybaseIQ' indicates the SapSybaseIQ database system.
'kDB2' indicates the DB2 database system.
'kSapASE' indicates the SapASE database system.
'kMariaDB' indicates the MariaDB database system.
'kPostgreSQL' indicates the PostgreSQL database system.
'kHPUX' indicates the HPUX database system.
'kVOS' indicates the VOS database system.
'kOther' indicates the other types of operating system.

hostOsType

compactVersion

string

Specifies the compact version of Cohesity agent. For example, 6.0.1.
Setting this parameter will filter the response based on installed agent
version.

outputFormat

string

Specifies the format for the output such as 'csv' or 'json'.
If not specified, the json format is returned.
If 'csv' is specified, a comma-separated list with a heading
row is returned.

healthStatus

array of strings

Specifies the health status of the Cohesity agent. Setting this parameter
will filter the response based on agent health status.
Specifies the status of the agent running on a physical source.
'kUnknown' indicates the Agent is not known. No attempt to connect
to the Agent has occurred.
'kUnreachable' indicates the Agent is not reachable.
'kHealthy' indicates the Agent is healthy.
'kDegraded' indicates the Agent is running but in a degraded state.

healthStatus

Allowed:

includeSummary

boolean

When true, the JSON response wraps agents in an envelope that includes
a fleet-level summary. Default is false (plain array for backward
compatibility).

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