Overview
Suggest changes
The Audit service records information about the operations performed by the BlueXP services. This includes the originating IP addresses, workspaces, Connectors used, and other telemetry data. You can use this data to determine what actions were performed, who performed them, and when they occurred. This information can be useful in forensic situations or environments where compliance is required. The associated REST API provides several endpoints you can use to retrieve the audit data and account options. The identity of the API caller and account are established through a user access token that must be included with each call. All Audit service API calls in this document are short-lived and run synchronously.
|
Before using the API reference documentation, review the Get started section for the BlueXP APIs. For more information about the security tokens and identifiers you'll need when using the API, review the Common workflows and tasks section. |
REST implementation
HTTP methods
| Method | Description |
|---|---|
|
Retrieve an object instance or collection |
Request headers
| Request Header | Description |
|---|---|
|
Required. Contains the JWT access token |
Query parameters
A list of all the possible query parameters available for each service component is provided in the table below. This is a summary by component, however not every query parameter can be used with each endpoint in a specific component. See the detailed descriptions of the individual API calls for more details.
| Component | Query Parameter |
|---|---|
Audit |
account (required) |
Response headers
This API uses the standard HTTP response headers common with all BlueXP APIs. See REST implementation for more information.
HTTP status codes
| HTTP Status Code | Description |
|---|---|
|
OK: Returned for successful operation completion |
|
Bad Request: Returned if the input is malformed and could not be parsed |
|
Unauthorized: Returned if user authentication failed or the token has expired |
|
Forbidden: Returned for authorization errors depending on the resource and token |
Error handling
There are two processes involved with error handling and processing:
-
The error is logged for supportability
-
The error is also returned to the caller for any specific handling
cURL examples
Retrieve audit records for a specified account
This example retrieves the audit records for a specified account.
curl -X GET "https://cloudmanager.cloud.netapp.com/audit/<account_id>" -H "accept: application/json" -H "authorization: <user token>"