RunReveal

AlertsFacets returns the disjunctive filter-menu aggregates (severity, mitre, category, detectionID, actor, ip) for the alerts list given the current filter context. Counts are disjunctive so multi-select stays useful; the actor, ip, and detectionID facets are high-cardinality (top-N + type-ahead via FacetKey/FacetQuery).

AlertsFacets returns the disjunctive filter-menu aggregates (severity, mitre, category, detectionID, actor, ip) for the alerts list given the current filter context. Counts are disjunctive so multi-select stays useful; the actor, ip, and detectionID facets are high-cardinality (top-N + type-ahead via FacetKey/FacetQuery).

POST
/alerts/facets

Request Body

application/jsonRequired

actorarray<string>

actorModestring

alertIDstring

categoryarray<string>

categoryModestring

detectionIDarray<string>

detectionIDModestring

facetKeystring

facetQuerystring

fromobject

iparray<string>

ipModestring

limitinteger

mitrearray<string>

mitreModestring

offsetinteger

searchstring

severityarray<string>

severityModestring

signalTypestring

sortstring

toobject

curl -X POST "https://api.runreveal.com/alerts/facets" \
  -H "Content-Type: application/json" \
  -d '{
    "actor": [
      "string"
    ],
    "actorMode": "string",
    "alertID": "string",
    "category": [
      "string"
    ],
    "categoryMode": "string",
    "detectionID": [
      "string"
    ],
    "detectionIDMode": "string",
    "facetKey": "string",
    "facetQuery": "string",
    "from": {},
    "ip": [
      "string"
    ],
    "ipMode": "string",
    "limit": 0,
    "mitre": [
      "string"
    ],
    "mitreMode": "string",
    "offset": 0,
    "search": "string",
    "severity": [
      "string"
    ],
    "severityMode": "string",
    "signalType": "string",
    "sort": "string",
    "to": {}
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "buckets": {
      "property1": [
        {
          "count": 0,
          "label": "string",
          "value": "string"
        }
      ],
      "property2": [
        {
          "count": 0,
          "label": "string",
          "value": "string"
        }
      ]
    }
  },
  "success": true
}

AlertsList returns one offset page of the workspace's alerts (rows of the ClickHouse detections table) plus a total over the same time window and filters. The window defaults to the last 7 days when the request omits it, so the scan is always bounded; the AlertID field is a window-less single-alert deep-link.

POST
/alerts/list

Request Body

application/jsonRequired

actorarray<string>

actorModestring

alertIDstring

categoryarray<string>

categoryModestring

detectionIDarray<string>

detectionIDModestring

facetKeystring

facetQuerystring

fromobject

iparray<string>

ipModestring

limitinteger

mitrearray<string>

mitreModestring

offsetinteger

searchstring

severityarray<string>

severityModestring

signalTypestring

sortstring

toobject

curl -X POST "https://api.runreveal.com/alerts/list" \
  -H "Content-Type: application/json" \
  -d '{
    "actor": [
      "string"
    ],
    "actorMode": "string",
    "alertID": "string",
    "category": [
      "string"
    ],
    "categoryMode": "string",
    "detectionID": [
      "string"
    ],
    "detectionIDMode": "string",
    "facetKey": "string",
    "facetQuery": "string",
    "from": {},
    "ip": [
      "string"
    ],
    "ipMode": "string",
    "limit": 0,
    "mitre": [
      "string"
    ],
    "mitreMode": "string",
    "offset": 0,
    "search": "string",
    "severity": [
      "string"
    ],
    "severityMode": "string",
    "signalType": "string",
    "sort": "string",
    "to": {}
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "limit": 0,
    "offset": 0,
    "total": 0,
    "values": [
      {
        "actor": {
          "property1": "string",
          "property2": "string"
        },
        "categories": [
          "string"
        ],
        "columnNames": [
          "string"
        ],
        "columnTypes": [
          "string"
        ],
        "createdAt": {},
        "detectionID": "string",
        "detectionName": "string",
        "detectionType": "string",
        "dstIP": "string",
        "error": "string",
        "id": "string",
        "mitreAttacks": [
          "string"
        ],
        "notificationNames": [
          "string"
        ],
        "receivedAt": {},
        "recordsReturned": 0,
        "resources": [
          "string"
        ],
        "results": "string",
        "scheduledRunID": "string",
        "severity": "string",
        "srcIP": "string",
        "workspaceID": "string"
      }
    ]
  },
  "success": true
}

AlertNotificationSend sends a notification for a specific alert. It retrieves the alert data and sends it using the specified template and channels.

AlertNotificationSend sends a notification for a specific alert. It retrieves the alert data and sends it using the specified template and channels.

POST
/alerts/send-notification

Request Body

application/jsonRequired

detectionIDstring

notificationNamesarray<string>

resultIDstring

scheduledRunIDstring

templateNamestring

templateSourcestring

curl -X POST "https://api.runreveal.com/alerts/send-notification" \
  -H "Content-Type: application/json" \
  -d '{
    "detectionID": "string",
    "notificationNames": [
      "string"
    ],
    "resultID": "string",
    "scheduledRunID": "string",
    "templateName": "string",
    "templateSource": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "channelErrors": {
      "property1": "string",
      "property2": "string"
    }
  },
  "success": true
}

AlertTriage triggers an on-demand AI triage for a specific alert. It creates an investigation linked to the alert and queues an async agent task.

AlertTriage triggers an on-demand AI triage for a specific alert. It creates an investigation linked to the alert and queues an async agent task.

POST
/alerts/triage

Request Body

application/jsonRequired

agentConfigIdstring

detectionIDstring

resultIDstring

scheduledRunIDstring

curl -X POST "https://api.runreveal.com/alerts/triage" \
  -H "Content-Type: application/json" \
  -d '{
    "agentConfigId": "string",
    "detectionID": "string",
    "resultID": "string",
    "scheduledRunID": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "investigationID": "string"
  },
  "success": true
}