Search Alerts
thehive.search_alerts
ActionBusiness appsconnection required
Calls the TheHive API with the connection's credentials.
Search alerts by title, type, source, status or a raw filter.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- TheHive
- Secret shape
- the TheHive API key, or {"api_key": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
10 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
title Keep alerts whose title contains this text. | string | No | — | — | — |
alert_type Keep alerts of exactly this type. | string | No | — | — | — |
source Keep alerts raised by exactly this source. | string | No | — | — | — |
source_ref Keep the alert carrying exactly this source reference. | string | No | — | — | — |
status Keep alerts in exactly this status, e.g. New or Imported. | string | No | — | — | — |
filters A raw TheHive filter expression as JSON, e.g. {"_in": {"_field": "status", "_values": ["New", "InProgress"]}}. It is combined with the fields above using _and. | object | No | — | — | {"_in":{"_field":"status","_values":["New","InProgress"]}} |
sort_by Field to sort by, using TheHive's own field name, e.g. _createdAt. | string | No | — | — | _createdAt |
sort_order Sort direction applied to 'sort_by'. | string | No | desc | one of "asc", "desc" | — |
start Index of the first record to return, counting from 0. | number | No | 0 | ≥ 0 | — |
limit How many records to return in this page. | number | No | 50 | 1–1000 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"filters": {
"_in": {
"_field": "status",
"_values": [
"New",
"InProgress"
]
}
},
"limit": 50,
"sort_by": "_createdAt",
"sort_order": "desc",
"start": 0
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items[]._id TheHive's internal id for the alert. | string | — |
items[].type The alert type, as sent by the source. | string | — |
items[].source The system the alert came from. | string | — |
items[].sourceRef The source's own reference for the alert. | string | — |
items[].title The alert title. | string | — |
items[].description The alert description, as Markdown. | string | — |
items[].severity Severity as TheHive's numeric code. | number | — |
items[].severityLabel The label TheHive shows for that severity. | string | — |
items[].status Where the alert is in its triage lifecycle. | string | — |
items[].stage The broader stage the status belongs to. | string | — |
items[].tlp Traffic Light Protocol level as TheHive's numeric code. | number | — |
items[].pap Permissible Actions Protocol level as a numeric code. | number | — |
items[].tags The tags carried by the alert. | array | — |
items[].date When the alert was raised, in epoch milliseconds. | number | — |
items[].follow True when updates from the source keep flowing in. | boolean | — |
items[].observableCount How many observables the alert carries. | number | — |
items[].caseId Id of the case the alert was imported into, once it was. | string | — |
items[]._createdAt When the alert was created, in epoch milliseconds. | number | — |
count How many alerts this page returned. | number | — |
{
"count": 0,
"items": [
{
"_createdAt": 0,
"_id": "",
"caseId": "",
"date": 0,
"description": "",
"follow": false,
"observableCount": 0,
"pap": 0,
"severity": 0,
"severityLabel": "",
"source": "",
"sourceRef": "",
"stage": "",
"status": "",
"tags": [],
"title": "",
"tlp": 0,
"type": ""
}
]
}See Search Alerts run in a workflow.
In a technical demo we add the TheHive connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.