List Audit Events
GET /v1/audit/events
Authentication
Requires authentication via: OAuth2PasswordBearer.
Parameters
| Name | In | Type | Required | Description | Constraints |
|---|---|---|---|---|---|
event_group | query | string | null | No | nullable | |
event_type | query | string | null | No | nullable | |
status | query | string | null | No | nullable | |
user_id | query | integer | null | No | nullable | |
vm_id | query | string | null | No | nullable | |
session_id | query | string | null | No | nullable | |
cursor | query | string | null | No | nullable | |
limit | query | integer | No | default=50, min=1, max=200 | |
X-API-Key | header | string | null | No | nullable |
Responses
200
Successful Response
application/json
Resolved schema:
{
"properties": {
"items": {
"items": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"user_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "User Id"
},
"actor_type": {
"type": "string",
"title": "Actor Type"
},
"actor_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Actor Id"
},
"source": {
"type": "string",
"title": "Source"
},
"event_group": {
"type": "string",
"title": "Event Group"
},
"event_type": {
"type": "string",
"title": "Event Type"
},
"status": {
"type": "string",
"title": "Status"
},
"resource_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Resource Type"
},
"resource_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Resource Id"
},
"session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Session Id"
},
"vm_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Vm Id"
},
"task_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Task Id"
},
"request_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Request Id"
},
"correlation_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Correlation Id"
},
"http_method": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Http Method"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path"
},
"http_status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Http Status"
},
"latency_ms": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Latency Ms"
},
"ip_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ip Address"
},
"user_agent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "User Agent"
},
"node_ip": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Node Ip"
},
"worker_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Worker Id"
},
"event_payload": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Event Payload"
},
"error_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error Message"
}
},
"type": "object",
"required": [
"id",
"created_at",
"actor_type",
"source",
"event_group",
"event_type",
"status"
],
"title": "AuditEventResponse"
},
"type": "array",
"title": "Items"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
}
},
"type": "object",
"required": [
"items"
],
"title": "AuditEventListResponse"
}
Field details:
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
items | array<object> | Yes | ||
items[] | object | Yes | ||
items[].id | string | Yes | ||
items[].created_at | string | Yes | format=date-time | |
items[].user_id | integer | null | No | nullable | |
items[].actor_type | string | Yes | ||
items[].actor_id | string | null | No | nullable | |
items[].source | string | Yes | ||
items[].event_group | string | Yes | ||
items[].event_type | string | Yes | ||
items[].status | string | Yes | ||
items[].resource_type | string | null | No | nullable | |
items[].resource_id | string | null | No | nullable | |
items[].session_id | string | null | No | nullable | |
items[].vm_id | string | null | No | nullable | |
items[].task_id | integer | null | No | nullable | |
items[].request_id | string | null | No | nullable | |
items[].correlation_id | string | null | No | nullable | |
items[].http_method | string | null | No | nullable | |
items[].path | string | null | No | nullable | |
items[].http_status | integer | null | No | nullable | |
items[].latency_ms | number | null | No | nullable | |
items[].ip_address | string | null | No | nullable | |
items[].user_agent | string | null | No | nullable | |
items[].node_ip | string | null | No | nullable | |
items[].worker_id | string | null | No | nullable | |
items[].event_payload | object | null | No | nullable | |
items[].error_message | string | null | No | nullable | |
next_cursor | string | null | No | nullable |
422
Validation Error
application/json
Resolved schema:
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
Field details:
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
detail | array<object> | No | ||
detail[] | object | No | ||
detail[].loc | array<string | integer> | No | ||
detail[].loc[] | string | integer | No | ||
detail[].msg | string | No | ||
detail[].type | string | No |