get https://api.compose.io/2016-07/audit_events
Retrieve all audit events to which your user has access.
Returned JSON
This endpoint returns an _embedded
key which contains an audit_events
key. That key's value is an array of audit events selected on the basis of the query parameters. Each element of the array contains an audit event object. The key/values of audit event objects are detailed below.
Key | Description |
---|---|
id | The ID of the audit event. This is the same ID as the one used in the path parameters. |
account_id | The account ID associated with the audit event. |
deployment_id | The deployment ID associated with the audit event. |
cluster_id | The cluster ID associated with the audit event. |
user_id | The user ID associated with the audit event. |
created_at | The date that the audit event was created. |
data | Any pertinent data recorded with the audit event. |
The email address of the user who initiated the action described by the audit event. | |
event | The type of the audit event. |
ip | The IP address of the user who initiated the action described by the event. |
user_agent | The user agent of the user who initiated the action described by the event. |
Returned Links
One or more of the following links will be present in the JSON _links object. All links are in templated format, meaning that an {?embed}
string within the link is the template's marker to add further parameters.
Link | Description |
---|---|
self | A URI for this audit event. |