PIpixiebrix
support

GET /api/support/organizations/{org_pk}/security-events/

Changed on

Return an organization's security events (newest first) with the same category/severity/action/destination rollups as the Admin Console report, scoped to <org_pk> in the path. Supports the category/rule_type/severity/action/destination/precision/user/groups/start/end/limit facets. Gated on the Support auth group, not the customer's org role; not gated on the activity-tracking flag (data captured while it was on stays readable after it is turned off).

Request

  • Base URL
    https://app.pixiebrix.com
  • Auth
    none declared

Path parameters

org_pkstring required

Query parameters

userstring uuid

Optional member UUID to scope the report to one user.

groupsstring[]

Optional group UUIDs to scope the report; repeated (?groups=a&groups=b) or comma-separated (?groups=a,b).

startstring date-time

Optional ISO-8601 start of the report window (inclusive).

endstring date-time

Optional ISO-8601 end of the report window (exclusive).

limitinteger

Optional maximum number of rows to return.

rule_typestring

Filter by rule type, independent of custom rule categories.

categorystring

Optional security-event category to filter the list by.

severity'info' | 'low' | 'medium' | 'high' | 'critical'

Optional security-event severity to filter the list by.

actionstring

Optional graduated-action (monitor/warn/block/softBlock) to filter the list by.

destinationstring

Optional file-upload destination to filter the list by.

precisionstring

Optional Interaction-Matching precision (L0/L1/L2) to filter the list by.

Response

organizationstring uuid required
startstring date-time required
endstring date-time required
events_truncatedboolean required

Changes

  • bde42d847d17Revision changes
    • info

      added the new optional query request parameter rule_type

    • info

      added the required property // to the response with the status (media type: application/json; version=2.0)

    • info

      added the required property // to the response with the status (media type: application/vnd.pixiebrix.api+json; version=2.0)

  • bcc966c3991cRevision changes
    • info

      added the required property // to the response with the status (media type: application/json; version=2.0)

    • info

      added the required property // to the response with the status (media type: application/vnd.pixiebrix.api+json; version=2.0)