Skip to main content
GET
Search ESI findings.

Authorizations

X-API-Key
string
header
required

Infrawatch API key. Supply the complete key directly as the header value.

Path Parameters

project_uuid
string<uuid>
required

Query Parameters

q
string

Case-insensitive literal substring search over finding titles, descriptions, types, lifecycle values, and source metadata. Finding evidence JSON is returned as metadata but is not searched.

Maximum string length: 256
type
enum<string>[]

Result families to include. Only finding is currently supported.

Maximum array length: 1
Available options:
finding
exposure_kind
string[]

Exact exposure kinds to include. Repeat or comma-separate for multi-select filtering.

Maximum array length: 25
Maximum string length: 256
finding_status
enum<string>[]

Exact finding lifecycle states to include. Repeat or comma-separate for multi-select filtering.

Maximum array length: 25
Available options:
open,
accepted,
resolved,
ignored,
false_positive
finding_severity
enum<string>[]

Exact finding severities to include. Repeat or comma-separate for multi-select filtering.

Maximum array length: 25
Available options:
critical,
high,
moderate,
low,
informational
finding_confidence
enum<string>[]

Exact finding confidence levels to include. Repeat or comma-separate for multi-select filtering.

Maximum array length: 25
Available options:
low,
medium,
high
limit
integer
default:50
Required range: 1 <= x <= 250
offset
integer
default:0
Required range: x >= 0

Response

ESI search results.

pagination
object
required
query_text
string
required
results
object[]
required
total_relation
enum<string>
required
Available options:
eq