circle-info
Version 2.19 is deprecated. Upgrade to a newer supported version.
chevron-right
search
Contact support

Audit

The audit log provides audit trail information for user activity, changes to business objects and other important information. For more information, see Audit logarrow-up-right.

Deprecated

hashtag
Get audit logs.

get

Retrieve audit logs using the query parameters.

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
startstring · date-timeOptional

Starting date for audit logs retrieval. format yyyy-MM-dd for date yyyy-MM-ddTHH:mm:ss for date-time.

Example: 2022-06-07T09:01:02
endstring · date-timeOptional

Ending date for audit logs retrieval. format yyyy-MM-dd for date yyyy-MM-ddTHH:mm:ss for date-time.

Example: 2022-06-07T09:01:02
cluster_uuidstringOptional

The cluster uuid of the logged operation (for cluster related operations)

Example: 123e4567-e89b-12d3-a456-426614174000
actionstringOptional

The action of the logged operation.

Example: Create
source_typestringOptional

The type of the source of the action.

Example: User
source_idstringOptional

The id of the source of the action.

Example: 96a4382e-afa5-4604-9eb1-c3071aa021fc
source_namestringOptional

The name of the source of the action.

Example: [email protected]
entity_typestringOptional

The type of the action related entity.

Example: Department
entity_idstringOptional

The id of the action related entity.

Example: 51
limitinteger · int32 · min: 1 · max: 500Optional

The maximum number of entries to return.

Default: 50
offsetinteger · int32Optional

The offset of the first item returned in the collection.

Example: 100
successstringOptional

enter true for success audits and false for failures (leave blank for all)

Example: true
downloadstringOptional

enter true to download the logs into logs.json file

Example: true
Responses
chevron-right
200

Filtered audit logs returned successfully

application/json
get
/v1/k8s/audit
PreviousUsersNextAuditLogs

Last updated