Skip to main content
GET
Search reports.

Authorizations

X-API-Key
string
header
required

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

Query Parameters

q
string

Report text, publisher, or exact IP indicator to search for.

Maximum string length: 256
source
string

Case-insensitive publisher name or source identifier filter.

Maximum string length: 256
date_from
string<date-time>

Inclusive lower bound for the publication date, falling back to the UTC date first stored.

date_to
string<date-time>

Inclusive upper bound for the publication date, falling back to the UTC date first stored.

ip_presence
enum<string>

Restrict results to reports with or without an IP indicator.

Available options:
with,
without
source_kind
enum<string>
Available options:
upstream
indicator_type
enum<string>

Indicator type to match. Must be provided together with indicator; combines with all other report filters using intersection semantics.

Available options:
ip,
domain,
md5,
sha1,
sha256
indicator
string

A value matching indicator_type. Must be provided together with indicator_type. Domains and IP addresses may be defanged and are normalized before lookup; hashes must contain the exact number of hexadecimal bytes for their type.

Required string length: 1 - 512
sort
enum<string>[]

Ordered report catalogue fields. Repeat the parameter to add secondary sorts.

Maximum array length: 3
Available options:
report,
coverage,
published
direction
enum<string>[]

Directions aligned by position with each sort field. Repeat for secondary sorts.

Maximum array length: 3
Available options:
asc,
desc
limit
integer
default:100
Required range: 1 <= x <= 500
offset
integer
default:0
Required range: x >= 0

Response

Matching reports.

pagination
object
required
reports
object[]
required
indicator
string

Present when the request supplied the paired indicator_type and indicator filters.

Required string length: 1 - 512
indicator_type
enum<string>

Present when the request supplied the paired indicator_type and indicator filters.

Available options:
ip,
domain,
md5,
sha1,
sha256