Audit events API 1.6.0
Audit log records and system operation events.
Base path: https://{controller_ip}/api/v1.
API description version: 1.6.0.
Examples use placeholder values for passwords, tokens, UUIDs, addresses and secrets. Replace them with values from your controller before sending requests.
Section methods
GET /audit_events/
Section: Audit events.
Returns data for the audit events endpoint /audit_events/.
Request example
curl -k -X GET "https://{controller_ip}/api/v1/audit_events/" \
-H "Authorization: Bearer <token>"
Response command example
curl -k -sS -X GET "https://{controller_ip}/api/v1/audit_events/" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"data": [],
"meta": {
"api_version": "1.6.0",
"path": "/audit_events/"
}
}
GET /audit_events/count
Section: Audit events.
Returns a count for the audit events endpoint /audit_events/count.
Request example
curl -k -X GET "https://{controller_ip}/api/v1/audit_events/count" \
-H "Authorization: Bearer <token>"
Response command example
curl -k -sS -X GET "https://{controller_ip}/api/v1/audit_events/count" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"count": 12
}
GET /audit_events/types
Section: Audit events.
Returns reference values for the audit events endpoint /audit_events/types.
Request example
curl -k -X GET "https://{controller_ip}/api/v1/audit_events/types" \
-H "Authorization: Bearer <token>"
Response command example
curl -k -sS -X GET "https://{controller_ip}/api/v1/audit_events/types" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"data": [],
"meta": {
"api_version": "1.6.0",
"path": "/audit_events/types"
}
}
GET /audit_events/{uuid}
Section: Audit events.
Returns data for the audit events endpoint /audit_events/{uuid}.
Request example
curl -k -X GET "https://{controller_ip}/api/v1/audit_events/{uuid}" \
-H "Authorization: Bearer <token>"
Response command example
curl -k -sS -X GET "https://{controller_ip}/api/v1/audit_events/{uuid}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"data": [],
"meta": {
"api_version": "1.6.0",
"path": "/audit_events/{uuid}"
}
}
POST /audit_events/user_defined/
Section: Audit events.
Creates a record or starts an operation for the audit events endpoint /audit_events/user_defined/.
Request example
curl -k -X POST "https://{controller_ip}/api/v1/audit_events/user_defined/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"type": "custom_audit",
"message": "External audit event"
}'
Request body example
{
"type": "custom_audit",
"message": "External audit event"
}
Response command example
curl -k -sS -X POST "https://{controller_ip}/api/v1/audit_events/user_defined/" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
PUT /audit_events/user_defined/{uuid}
Section: Audit events.
Updates data for the audit events endpoint /audit_events/user_defined/{uuid}.
Request example
curl -k -X PUT "https://{controller_ip}/api/v1/audit_events/user_defined/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"type": "custom_audit",
"message": "External audit event"
}'
Request body example
{
"type": "custom_audit",
"message": "External audit event"
}
Response command example
curl -k -sS -X PUT "https://{controller_ip}/api/v1/audit_events/user_defined/{uuid}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
DELETE /audit_events/user_defined/{uuid}
Section: Audit events.
Deletes data for the audit events endpoint /audit_events/user_defined/{uuid}.
Request example
curl -k -X DELETE "https://{controller_ip}/api/v1/audit_events/user_defined/{uuid}" \
-H "Authorization: Bearer <token>"
Response command example
curl -k -sS -X DELETE "https://{controller_ip}/api/v1/audit_events/user_defined/{uuid}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"deleted": true
}