Get Audit Event

GET /v1/audit/events/{event_id}

Authentication

Requires authentication via: OAuth2PasswordBearer.

Parameters

Name	In	Type	Required	Description	Constraints
event_id	path	string	Yes
X-API-Key	header	string | null	No		nullable

Responses

200

Successful Response

application/json

Resolved schema:

{
  "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"
}

Field details:

Field	Type	Required	Description	Constraints
id	string	Yes
created_at	string	Yes		format=date-time
user_id	integer | null	No		nullable
actor_type	string	Yes
actor_id	string | null	No		nullable
source	string	Yes
event_group	string	Yes
event_type	string	Yes
status	string	Yes
resource_type	string | null	No		nullable
resource_id	string | null	No		nullable
session_id	string | null	No		nullable
vm_id	string | null	No		nullable
task_id	integer | null	No		nullable
request_id	string | null	No		nullable
correlation_id	string | null	No		nullable
http_method	string | null	No		nullable
path	string | null	No		nullable
http_status	integer | null	No		nullable
latency_ms	number | null	No		nullable
ip_address	string | null	No		nullable
user_agent	string | null	No		nullable
node_ip	string | null	No		nullable
worker_id	string | null	No		nullable
event_payload	object | null	No		nullable
error_message	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