Skip to main content
GET
Get vulnerability rollups for authorized partner tenants.

Authorizations

Authorization
string
header
required

A machine-client token from POST /v1/auth/client-token, carrying subject_type=machine_client and the pulse.read scope.

Scopes

pulse.read

Query Parameters

tenant_ids
string

Comma-separated tenant ids to read. Every id must be inside the caller's authorized scope, otherwise 403 tenant_out_of_scope. Omit it to read every authorized tenant.

from
string
required

Required. First day of the range, yyyy-MM-dd. Must not be later than to.

to
string
required

Required. Last day of the range, yyyy-MM-dd.

group_by
enum<string>

What to group the rows by: cve (the default), root_cause, severity or asset_type. Anything else returns 400 invalid_group_by.

Available options:
cve,
root_cause,
severity,
asset_type
limit
string

The most rows to return per tenant: 1-100, default 25. Anything else returns 400 invalid_limit.

Response

The rollup rows for each covered tenant.

Vulnerability rollups per tenant, grouped by one dimension over a date range.

root_tenant_id
string<uuid>
required

The top of the caller's authorized scope.

from
string<date>
required

First day of the range, as requested.

to
string<date>
required

Last day of the range, as requested.

group_by
string
required

The dimension the rows are grouped by: cve, root_cause, severity or asset_type.

limit
required

The most rows returned per tenant.

coverage
object[]
required

The tenants the rollups were read from.

tenants
object[]
required

The rollups, one entry per tenant read.