Search Cases

thehive.search_cases
ActionBusiness appsconnection required

Calls the TheHive API with the connection's credentials.

Search cases by title, status, assignee or a raw filter expression.

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

9 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
title
Keep cases whose title contains this text.
stringNo———
status
The case status to set.
stringNo—one of "New", "InProgress", "Indeterminate", "FalsePositive", "TruePositive", "Other", "Duplicated"—
assignee
Keep cases assigned to this login.
stringNo———
severity
Severity as TheHive's numeric code: 1 low, 2 medium, 3 high, 4 critical.
numberNo—1–4—
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.
objectNo——{"_in":{"_field":"status","_values":["New","InProgress"]}}
sort_by
Field to sort by, using TheHive's own field name, e.g. _createdAt.
stringNo——_createdAt
sort_order
Sort direction applied to 'sort_by'.
stringNodescone of "asc", "desc"—
start
Index of the first record to return, counting from 0.
numberNo0≥ 0—
limit
How many records to return in this page.
numberNo501–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

FieldTypeExample
items[]._id
TheHive's internal id for the case.
string—
items[].number
The human-facing case number.
number—
items[].title
The case title.
string—
items[].description
The case 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 case is in its lifecycle, e.g. New or InProgress.
string—
items[].stage
The broader stage the status belongs to.
string—
items[].tlp
Traffic Light Protocol level as TheHive's numeric code.
number—
items[].tlpLabel
The label TheHive shows for that TLP level.
string—
items[].pap
Permissible Actions Protocol level as a numeric code.
number—
items[].tags
The tags carried by the case.
array—
items[].assignee
Login of the analyst the case is assigned to.
string—
items[].startDate
When the case started, in epoch milliseconds.
number—
items[]._createdAt
When the case was created, in epoch milliseconds.
number—
items[]._createdBy
Login of the user who created the case.
string—
count
How many cases this page returned.
number—
{
  "count": 0,
  "items": [
    {
      "_createdAt": 0,
      "_createdBy": "",
      "_id": "",
      "assignee": "",
      "description": "",
      "number": 0,
      "pap": 0,
      "severity": 0,
      "severityLabel": "",
      "stage": "",
      "startDate": 0,
      "status": "",
      "tags": [],
      "title": "",
      "tlp": 0,
      "tlpLabel": ""
    }
  ]
}

See Search Cases 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.