List Alert Events

Returns a paginated list of alert events. Events are system-generated and read-only via the API.

GET /api/v2/alert-events

List Alert Events

cURL

curl --request GET \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/alert-events \
  --header 'Authorization: Bearer <token>'

200

{
  "count": 1,
  "skip": 1,
  "limit": 1,
  "data": {
    "events": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>",
        "message": "<string>",
        "data": {},
        "created_at": "2023-11-07T05:31:56Z",
        "attempts_queued_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

JWTBearerTokenSignedRequest & RequestDate & HMACSignature

Authorization · string · header · required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer · string · default: wait=30

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. Passing in wait=-1 bypasses all timeout limits when the feature is enabled.

Pattern: ^wait=(-1|[0-9]+)$

Query Parameters

skip · integer

This query parameter is used for determining the number of objects to skip in pagination. The number of items to skip in a paginated response.

Required range: x >= 0

limit · integer

This query parameter is used for setting an upper limit of objects returned in paginated responses. The limit of results requested by the client.

Required range: x >= 0

sort_by · string

Sortable columns are created_at, attempts_queued_at. Default -created_at (most recent first). Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

type · string

Supported operators are eq and neq. Must provide valid alert event types. Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Pattern: ^((eq|~eq|neq):)?[^:]+$

created_at · string

Filter results by created_at value. See filter schema details for valid predicates. Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Pattern: ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$

delivered · string

When set to false, returns only events with attempts_queued_at IS NULL (events that have not yet had delivery attempts queued).

Filter results by column boolean value. Valid filter predicates are eq, neq.

Pattern: ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$

Response

200

application/json

OK

count · integer

The total number of results.

Required range: x >= 0

skip · integer

The number of items to skip in a paginated response.

Required range: x >= 0

limit · integer

The limit of results requested by the client.

Required range: x >= 0

data · object

Show child attributes