Lists the cluster audit logs on the Cohesity Cluster that match the filter criteria specified using parameters.

get

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

Privileges: CLUSTER_AUDIT

When actions (such as a login or a Job being paused) occur on the
Cohesity Cluster, the Cluster generates Audit Logs.
If no parameters are specified, all logs currently on the Cohesity Cluster
are returned. Specifying the parameters filters the results that are returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

userNames

array of strings

Filter by user names who cause the actions that generate Cluster Audit
Logs.

userNames

domains

array of strings

Filter by domains of users who cause the actions that trigger
Cluster audit logs.

domains

entityTypes

array of strings

Filter by entity types involved in the actions that generate the
Cluster audit logs, such as User, Protection Job, View, etc.
For a complete list, see the Category drop-down in the Admin > Audit Logs
page of the Cohesity Dashboard.

entityTypes

actions

array of strings

Filter by the actions that generate Cluster audit logs such as
Activate, Cancel, Clone, Create, etc. For a complete list, see the
Actions drop-down in the Admin > Audit Logs page of the Cohesity
Dashboard.

actions

string

Filter by matching a substring in entity name or details of the
Cluster audit log.

startTimeUsecs

int64

Filter by a start time. Only Cluster audit logs that were generated after
the specified time are returned.
Specify the start time as a Unix epoch Timestamp (in microseconds).

endTimeUsecs

int64

Filter by a end time specified as a Unix epoch Timestamp
(in microseconds). Only Cluster audit logs that were generated before the
specified end time are returned.

startIndex

int64

Specifies an index number that can be used to return subsets of items
in multiple requests.
Break up the items to return into multiple requests by setting pageCount
and startIndex to return a subsets of items in the search result.
For example, set startIndex to 0 to get the first set of pageCount items
for the first request. Increment startIndex by pageCount
to get the next set of pageCount items for a next request.
Continue until all items are returned and therefore the total number of
returned items is equal to totalCount. Default value is 0.

pageCount

int64

Limit the number of items to return in the response for pagination
purposes. Default value is 1000.

outputFormat

string

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

tenantId

string

TenantId specifies the tenant whose action resulted in the audit log.

allUnderHierarchy

boolean

AllUnderHierarchy specifies if logs of all the tenants under the hierarchy
of tenant with id TenantId should be returned.

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