API reference Schemas
Schemas
Error
object
| Field | Type | Description |
|---|---|---|
error required | object | |
error.code required | string | Machine-readable. password_too_weak (400): a new password breaks the rules; details lists the rules missed (length, lowercase, uppercase, digit, symbol). For example invalid, not_found, forbidden, password_too_weak. |
error.message required | string | |
error.details | array of string |
ObservationBatch
object
What a collector observed on one asset (pkg/model.ObservationBatch)
| Field | Type | Description |
|---|---|---|
schema_version required | string | |
collector required | object | |
asset required | object | |
observations required | array of object | |
complete | boolean |
User
object
An account, as the organisation the request works in sees it (internal/store.User).
| Field | Type | Description |
|---|---|---|
id required | integer | For example 1. |
email required | string (email) | For example [email protected]. |
name required | string | For example Alex Demo. |
role required | string | Organisation-wide role in this organisation; empty for a member with project access only (access is then projects). For example admin, security, engineer, viewer, "". |
disabled required | boolean | |
created_at required | string (date-time) | |
last_login_at | string (date-time) or null | |
teams | array of string or null | |
instance_admin | boolean | |
access | string | One of organisation, projects, "". |
mfa_enabled | boolean | |
mfa_methods | array of string or null | |
phone | string | |
project_grants | integer | |
asset_grants | integer | |
access_teams | array of string or null |
LoginRequest
object
| Field | Type | Description |
|---|---|---|
email required | string (email) | |
password required | string (password) |
MFARequired
object
The account has a second factor: no session yet. A short-lived challenge cookie is set for /api/v1/auth/mfa; finish with POST /auth/mfa/verify (a code) or POST /auth/mfa/passkey/begin and /finish.
| Field | Type | Description |
|---|---|---|
mfa_required required | any | Always true. |
methods required | array of string | What the second step offers, strongest first. email appears only for an account with no other method. |
MFAVerifyRequest
object
| Field | Type | Description |
|---|---|---|
code required | string | A 6-digit code from the authenticator app or the email, or one recovery code. |
PasswordChangeRequest
object
| Field | Type | Description |
|---|---|---|
current_password required | string (password) | |
new_password required | string (password) | Must meet the organisation's password rules; otherwise 400 password_too_weak with the rules missed in details. |
revoke_tokens | boolean | Also revoke your API tokens. Default false. |
revoke_assistants | boolean | Also disconnect the AI assistants connected as you. Default true. |
PasswordChangeResult
object
| Field | Type | Description |
|---|---|---|
revoked required | object | What the new password ended. This session stays signed in (with a new session ID). |
revoked.sessions required | integer | |
revoked.tokens required | integer | |
revoked.assistants required | integer | |
tokens_kept required | integer | Your API tokens that still work. |
Me
object
The caller. Fields not listed here may be added; clients should ignore what they do not know.
| Field | Type | Description |
|---|---|---|
user required | one of User, null | null for a collector token |
role required | string | Organisation-wide role; empty with project access only. |
access required | string | One of organisation, projects. |
project_role | string | |
edition required | string | One of community, pro, enterprise. |
features required | array of string | For example ["remediation","teams","evidence_report","sso"]. |
feedback_enabled | boolean | |
workspace required | one of null, object | |
workspaces required | array of object | Organisations the caller belongs to. |
projects required | array of object | Projects for the project switcher. |
default_project_id required | integer | 0: All projects. |
mfa_enrolment_required | boolean | |
mfa_step_up_required | boolean | |
mfa_accepted | array of string or null | |
mfa_recovery_accepted | boolean | |
password_change_required | boolean | |
invite_only required | boolean | People join by invitation: POST /users is refused. |
ProjectRef
object
A project, by ID and name (internal/store.ProjectRef).
| Field | Type | Description |
|---|---|---|
id required | integer | For example 3. |
name required | string | For example demo-shop. |
Reporting
object
How an asset reports and what is expected of it (internal/store.Reporting).
| Field | Type | Description |
|---|---|---|
source required | string | What reports this asset (agent, an integration, a CLI or CI upload). For example agent. |
override required | string | A reporting mode set by hand; empty when learned. |
mode required | string | What the dashboard shows: agent, scheduled (a learned or set cadence), one_off (no further report expected), integration, or unknown (no report yet). For example agent, scheduled, one_off, integration, unknown. |
runs required | integer | Reports seen an hour apart or more, up to 6. For example 6. |
usual_seconds required | integer or null | Median gap between those reports (2 runs or more). For example 21600. |
due_after_seconds required | integer or null | How long after the last report the asset is overdue; null when nothing is expected. For example 43200. |
as_of | string (date-time) | The date the results are from when no further report is expected (one-off); absent otherwise. |
Asset
object
A server, application, repository, image or other asset (internal/store.Asset).
| Field | Type | Description |
|---|---|---|
id required | integer | For example 4. |
kind required | string | host, application, repository, image, managed_service, sbom, cluster or workload. For example host, application, repository, image, managed_service, sbom, cluster, workload. |
name required | string | For example demo-web-1. |
environment required | string | For example production. |
owner_team_id required | integer or null | The owning team; null when none. |
owner_team required | string | The owning team's name; empty when none. For example Platform. |
provider required | string | Cloud or platform, when known (aws, gcp, kubernetes...). For example aws. |
region required | string | For example eu-west-1. |
criticality required | string | For example high. |
internet_exposed required | boolean or null | Internet exposure set by hand; null when not set. |
exposed required | boolean or null | The exposure risk scoring uses: internet_exposed when set, else what collectors observed; null when not known. |
tags required | array of string or null | For example ["demo"]. |
attributes required | map of string or null | Facts collectors reported, such as os, os_version and arch. |
first_seen required | string (date-time) | |
last_seen required | string (date-time) | |
collection_status required | string | ok, partial, stale (overdue) or removed. For example ok, partial, stale, removed. |
component_count required | integer | Components currently installed or declared. For example 412. |
agent_polled_at required | string (date-time) or null | When the asset's agent last asked whether to report now; null for older agents and assets without one. |
projects required | array of ProjectRef | The active projects the asset belongs to that the caller may see. |
reporting required | Reporting |
Identifier
object
One of the identifiers an asset is matched by across reports (internal/store.Identifier).
| Field | Type | Description |
|---|---|---|
scheme required | string | For example hostname, machine-id, image-ref, git-url, demo. |
value required | string | For example demo-web-1. |
first_seen required | string (date-time) |
AssetDetail
object
| Field | Type | Description |
|---|---|---|
asset required | Asset | |
identifiers required | array of Identifier or null |
AssetList
object
One page of results: the items, the number of matches and the page asked for.
| Field | Type | Description |
|---|---|---|
items required | array of Asset | |
total required | integer | Matches in all pages. For example 42. |
limit | integer | Page size (default 100, at most 500); absent when 0. |
offset | integer | Items skipped; absent when 0. |
FindingList
object
One page of results: the items, the number of matches and the page asked for.
| Field | Type | Description |
|---|---|---|
items required | array of Finding | |
total required | integer | Matches in all pages. For example 42. |
limit | integer | Page size (default 100, at most 500); absent when 0. |
offset | integer | Items skipped; absent when 0. |
FindingVEX
object
A VEX statement about a finding (internal/store.FindingVEX).
| Field | Type | Description |
|---|---|---|
statement_id required | integer | |
document_id required | integer | |
source required | string | |
status required | string | For example not_affected, affected, fixed, under_investigation. |
justification required | string | |
impact_statement required | string | |
action_statement required | string | |
status_notes required | string | |
vulnerability required | string | For example CVE-2024-45337. |
effective_at required | string (date-time) | |
request_id required | integer or null | |
request_status required | string | For a not_affected statement: pending, approved or declined; empty otherwise or when the caller cannot see the inbox. For example pending, approved, declined, "". |
applied required | boolean | The finding is ignored by a rule made from this statement. |
Finding
object
A vulnerability or end-of-life issue of one component on one asset (internal/store.Finding).
| Field | Type | Description |
|---|---|---|
id required | integer | For example 173. |
kind required | string | vulnerability, end_of_life and the other finding kinds. For example vulnerability, end_of_life. |
key required | string | The CVE or other advisory ID, or the end-of-life product and cycle. For example CVE-2024-45337. |
inventory_id required | integer | |
asset_id required | integer | For example 4. |
asset_name required | string | For example demo-web-1. |
asset_kind required | string | For example host. |
environment required | string | For example production. |
component_id required | integer | |
component_name required | string | For example golang.org/x/crypto. |
component_type required | string | For example go. |
version required | string | For example 0.26.0. |
location required | string | Where the component was found (a path or manifest). For example /usr/local/bin/app. |
direct required | boolean or null | A direct dependency (true) or a transitive one (false); null when not known. |
status required | string | open or resolved. For example open, resolved. |
verification required | string | How certain the match is. For example confirmed, needs_validation, stale. |
severity required | string | For example critical, high, medium, low, unknown. |
score required | number or null | CVSS base score; null when not known. For example 9.1. |
title required | string | |
fixed_version required | string | The first version that fixes it; empty when none is known. For example 0.31.0. |
sources required | array of string or null | IDs of the advisories that matched. |
evidence required | any | Why it matched (JSON; shape depends on the collector). |
first_seen required | string (date-time) | |
last_seen required | string (date-time) | |
resolved_at required | string (date-time) or null | |
resolution required | string | How it was resolved; empty while open. |
known_exploited required | boolean | Listed in CISA's Known Exploited Vulnerabilities. |
state required | string | Workflow state. |
priority required | string | For example P1, P2, P3, P4, lower_priority. |
priority_score required | number | |
priority_factors required | any | What made up the priority (JSON). |
sos required | boolean | Matched an urgent (SOS) rule of the risk policy. |
sos_rule required | string | |
assignee_user_id required | integer or null | |
assignee_email required | string | |
assignee_team_id required | integer or null | |
assignee_team required | string | |
ack_due required | string (date-time) or null | |
fix_due required | string (date-time) or null | |
acknowledged_at required | string (date-time) or null | |
suppressed_until required | string (date-time) or null | |
state_reason required | string | |
mitigation required | string | |
escalation_level required | integer | |
incident_id required | integer or null | |
overdue required | boolean | |
fix_group required | string | The fix (upgrade) this finding is part of. |
priority_policy_version required | string | The version of the risk policy that produced priority, priority_score, priority_factors and sos. |
regressed_at required | string (date-time) or null | When the issue last came back after it was fixed. |
reachability | string | Whether the vulnerable code can run: unknown, reachable, not_imported or not_running. For example not_imported. |
reachability_evidence | array of string | What the reachability status is based on; empty when it is unknown. |
until_fix required | boolean | Snoozed or ignored until a free fixed version exists. |
ignore_reason required | string | accepted_risk, false_positive, mitigated or no_fix. For example accepted_risk, false_positive, mitigated, no_fix, "". |
exception_id required | integer or null | The ignore rule that set or last set the state. |
display_state required | string | The state the dashboard shows. For example new, to_do, in_progress, fixed, regressed, snoozed, accepted. |
second_check required | string | Result of the independent second check: agreed, disagreed or could_not_check; empty when none. A disagreement asks a person to look; it changes nothing. For example agreed, disagreed, could_not_check, "". |
second_check_reason required | string | What the second check found. |
resolution_kind required | string | Why it closed; empty while open. For example remediated, removed, superseded, advisory_withdrawn, advisory_changed, not_evaluated, other, "". |
resolution_detail required | any | The facts behind resolution_kind (JSON: advisories, source, withdrawn_at, version, plan_id, successor). |
epss required | number or null | FIRST's probability (0 to 1) that the CVE is exploited in the next 30 days; null when there is no score. For example 0.94. |
epss_percentile required | number or null | The score's rank among all scored CVEs (0 to 1). |
epss_date required | string (date-time) or null | The day the EPSS score is from. |
epss_model_version required | string or null | |
epss_cve required | string or null | The CVE the EPSS score is for (the highest-scored of the finding's CVEs). |
as_of required | string (date-time) or null | For an asset scanned once: the scan's date, which the finding is true as of. Null for assets that report regularly. |
vex required | one of FindingVEX, null | The latest imported VEX statement about this component version and vulnerability; null when none. |
Advisory
object
One advisory record from a feed (internal/store.Advisory).
| Field | Type | Description |
|---|---|---|
id required | string | The record's ID in its feed. For example GHSA-f82v-jwr5-mffw. |
feed required | string | For example osv:npm. |
group_key required | string | The CVE (or other ID) the record's aliases share; findings are keyed by it. For example CVE-2025-29927. |
aliases required | array of string | For example ["CVE-2025-29927"]. |
summary required | string | For example Authorization Bypass in Next.js Middleware. |
severity required | string | critical, high, medium, low or unknown. For example critical. |
score required | number or null | CVSS base score; null when the record has none. For example 9.1. |
vector required | string | For example CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:N. |
severity_source required | string | Where the severity came from. For example cvss_v3. |
published required | string (date-time) or null | |
modified required | string (date-time) | |
withdrawn required | string (date-time) or null | Set when the feed withdrew the record. |
references required | array of object | Links as the feed gives them. For example [{"type":"ADVISORY","url":"https://nvd.nist.gov/vuln/detail/CVE-2025-29927"}]. |
references[].url | string | |
references[].type | string | |
known_exploited required | boolean | Listed in CISA's Known Exploited Vulnerabilities catalogue. |
fetched_at required | string (date-time) |
WhyInstalled
object
The version evidence: what was observed, where and when (internal/why.Installed).
| Field | Type | Description |
|---|---|---|
version required | string | For example 13.4.0. |
compared | string | The version compared, when it was normalised first. |
from required | string | File, package database or collector the version was read from. For example /srv/shop/node_modules/[email protected]. |
collector required | string | For example linux-apps. |
confidence required | string | For example confirmed. |
observed_at required | string (date-time) or null |
WhySource
object
Where the claim comes from and how fresh it is (internal/why.Source).
| Field | Type | Description |
|---|---|---|
record | string | The advisory record that decided. For example GHSA-f82v-jwr5-mffw. |
ecosystem | string | For example npm. |
feed required | string | For example osv:npm. |
refreshed_at required | string (date-time) or null | When the feed last synced; null when it never has. |
stale required | boolean | The feed has not synced for longer than expected. |
WhyRule
object
The matching rule that was applied (internal/why.Rule).
| Field | Type | Description |
|---|---|---|
kind required | string | range, last_affected, no_fix_listed or listed_version for advisories; exact_cycle, version_prefix, package_name or windows_build for end of life. For example range. |
range | string | For example >= 13.0.0, < 13.5.9. |
comparator | string | For example semver. |
text required | string | For example in range >= 13.0.0, < 13.5.9, compared with SemVer rules. |
ambiguous | array of string | What made the matcher ask for a second check. For example ["sources_disagree"]. |
Explanation
object
Why a finding matched and how sure that is (internal/why.Explanation). The finding page leads with sentence.
| Field | Type | Description |
|---|---|---|
sentence required | string | For example Installed 13.4.0 (from /srv/shop/node_modules/[email protected], seen 28 min ago) is in the affected range >= 13.0.0, < 13.5.9 of GHSA-f82v-jwr5-mffw (osv:npm, refreshed 27 min ago), compared with SemVer rules; fixed in 13.5.9.. |
type required | string | package_advisory, os_package, container_image or end_of_life. For example package_advisory. |
installed required | WhyInstalled | |
source required | WhySource | |
rule required | WhyRule | |
fixed_version | string | For example 13.5.9. |
evidence_state required | string | confirmed, needs_validation, stale or rejected (docs/verification.md, "Evidence states"). For example confirmed. |
evidence_state_text required | string | What the evidence state means for this finding. |
as_of | string (date-time) or null | The date of the only scan of an asset scanned once. |
as_of_text | string | |
missing_information required | array of string | What exactly would resolve a finding that is not confirmed; empty when confirmed. |
second_check required | object or null | The independent second check: result (agreed, disagreed …), reason, differences, what it derived (independent) and checked_at; null before it has run. |
needs_review required | boolean | The second check disagrees. It never lowers priority; it asks a person to look. |
second_check_text required | string | For example The independent second check re-derived this from the raw advisory record and the raw observed version, and agreed.. |
reachability | object or null | Whether the vulnerable code can run and what that did to the priority: status (unknown, reachable, not_imported or not_running), evidence, lowered, kept and text; null when not assessed. |
epss | object | FIRST's exploit prediction for the finding's CVE and what it does to the priority: cve, score, percentile, date, model_version, threshold, release_below, points, counted, text. Absent for findings without a CVE. |
package | object | For application packages: ecosystem, name, direct (null when unknown) and location. |
os_package | object | For operating-system packages: release, source_package, backport, subscription and source_fix. |
container_image | object | For findings in a container image: image and inner_type (package_advisory or os_package). |
end_of_life | object | For end-of-life findings: product, cycle, eol_date and latest_in_cycle. |
SupportLine
object
The support status of one release line (internal/upgrade.Line).
| Field | Type | Description |
|---|---|---|
product required | string | For example nextjs. |
cycle required | string | For example 15. |
status required | string | supported, security_only or end_of_life. For example supported. |
support_until | string (date-time) | |
eol_date | string (date-time) | |
latest | string | For example 15.5.29. |
link | string | For example https://endoflife.date/nextjs. |
UpgradeRecommendation
object
The version to move to, from stored release data (internal/upgrade.Recommendation).
| Field | Type | Description |
|---|---|---|
purl_type required | string | For example npm. |
installed_version required | string | For example 13.4.0. |
minimum_fixed_version | string | The lowest version that fixes every issue it can. For example 15.5.28. |
recommended_version | string | For example 15.5.29. |
basis required | string | How the recommendation was chosen. For example latest_in_line. |
change_type | string | patch, minor, major or distro. For example major. |
requires_major required | boolean | |
requires_subscription | string | A paid channel the fix needs (Ubuntu Pro, SUSE LTSS). |
source | object | For a Debian or Ubuntu binary package built from a source package with another version: package, source_package, installed_source_version and fixed_source_version. Upgrade the binary package to a build from that source version; recommended_version is then empty. |
release_data required | string | Whether release data was available for the package. For example available. |
release_source | string | For example releases:npm. |
release_checked_at | string (date-time) | |
latest_stable | string | For example 16.4.6. |
latest_in_line | string | The newest stable release in the recommended version's major line. For example 15.5.29. |
recommended_yanked required | boolean | The registry withdrew (yanked, retracted or unlisted) the recommended version. |
minimum_fixed_yanked required | boolean | |
yanked_reason | string | |
installed_yanked required | boolean | |
deprecated | string | The maintainers' deprecation notice for the package. |
minimum_fixed_not_in_release_data required | boolean | |
lifecycle | SupportLine | |
target_lifecycle | SupportLine | |
supported_line | SupportLine | |
fixes required | array of string | Finding keys the recommended version resolves. For example ["CVE-2025-29927","nextjs:13"]. |
unfixed required | array of string | Keys it does not resolve (no fixed version, or a line that stays end of life). |
rationale required | array of string | For example ["15.5.29 is the newest stable release in the 15.x line and is at or above the minimum fixed version 15.5.28."]. |
open_findings required | integer | For example 37. |
FindingDetail
object
One finding with why it matched, its advisories and, while it is open, its upgrade recommendation.
| Field | Type | Description |
|---|---|---|
finding required | Finding | |
why required | Explanation | |
advisories | array of Advisory | Vulnerabilities only: the advisories that matched this component. |
related_advisories | array of Advisory | Vulnerabilities only: other advisories sharing the CVE (for example the same issue in another package). |
upgrade | UpgradeRecommendation | Open findings only. |
FixPlace
object
One asset a fix applies to, when one fix is listed for several (internal/fixplan.Place).
| Field | Type | Description |
|---|---|---|
group_id required | string | The asset's own fix group. For example 8:package_upgrade:40. |
asset_id required | integer | For example 8. |
asset_name required | string | For example demo-wiki on demo-tools-1. |
asset_kind required | string | For example application. |
app_dir | string | For example /srv/wiki. |
environment required | string | For example production. |
finding_count required | integer | For example 53. |
FixGroup
object
One fix: an action and the findings it resolves (internal/fixplan.Group). Grouped by fix (group_by=fix), the same change in several places is one item listing its places.
| Field | Type | Description |
|---|---|---|
id required | string | Asset ID, kind and a number; percent-encode it in paths. For example 4:package_upgrade:11. |
kind required | string | security_updates, windows_update, old_kernels, package_upgrade, program_update, end_of_life, release_upgrade or no_fix. For example package_upgrade. |
title required | string | For example Upgrade lodash 4.17.20 → 4.18.1. |
action required | string | What to do, in a sentence or a command. For example Update lodash to 4.18.1, the newest stable release in its line, in the lockfile and redeploy. Any version from 4.18.0 fixes these issues.. |
asset_id required | integer | For example 4. |
asset_name required | string | For example demo-shop on demo-web-1. |
asset_kind required | string | For example application. |
environment required | string | For example production. |
app_dir | string | For example /srv/shop. |
fix_key required | string | The same for groups that make the same change in different places. For example package_upgrade:npm:lodash:4.17.20>4.18.0. |
component | string | For example lodash. |
from_version | string | For example 4.17.20. |
to_version | string | The minimum fixed version. For example 4.18.0. |
packages required | array of string | For example ["lodash"]. |
package_count required | integer | For example 1. |
finding_count required | integer | For example 4. |
unique_issues required | integer | Distinct CVE or advisory keys. For example 4. |
by_priority required | map of integer | Findings per priority. For example {"P1":2,"P2":2}. |
by_severity required | map of integer | Findings per severity. For example {"high":2,"medium":2}. |
top_priority required | string | For example P1. |
sos required | boolean | An issue of this fix is an SOS (drop everything). |
known_exploited required | integer | Findings known to be exploited. For example 0. |
needs | string | A paid channel the fix needs (ubuntu-pro, SUSE LTSS). |
effort required | string | low, medium or high. For example medium. |
note | string | |
recommended_version | string | For example 4.18.1. |
target_version | string | The version the title names: the recommended version when it is in the minimum fix's major line, otherwise the minimum fixed version. For example 4.18.1. |
change_type | string | For example minor. |
requires_major | boolean | |
recommended_yanked | boolean | |
rationale | array of string | For example ["4.18.1 is the newest stable release in the 4.x line and is at or above the minimum fixed version 4.18.0."]. |
reboot | boolean | The change takes effect only after a restart (a Windows cumulative update, or OS updates that include the kernel). |
no_fix_advice | object | For a fix with no fixed version: per-package advice in sections (kind, title, issues, items) and, for packages that come with an application, bundled (app, text, commands). |
places | array of FixPlace | Every asset the fix applies to, when groups are merged by fix_key; absent for one asset's group. |
FixGroupList
object
One page of results: the items, the number of matches and the page asked for.
| Field | Type | Description |
|---|---|---|
items required | array of FixGroup | |
total required | integer | Matches in all pages. For example 42. |
limit | integer | Page size (default 100, at most 500); absent when 0. |
offset | integer | Items skipped; absent when 0. |
FixOwner
object
Who a fix's open issues are assigned to (internal/store.OwnerCount).
| Field | Type | Description |
|---|---|---|
user_email required | string | Empty when assigned to a team or no one. For example "". |
team_name required | string | For example Development. |
count required | integer | For example 4. |
FixGroupDetail
object
One fix with a page of its findings and who owns them.
| Field | Type | Description |
|---|---|---|
group required | FixGroup | |
findings required | FindingList | |
owners required | array of FixOwner |
FixWork
object
Where the work on one fix stands, from its open issues (internal/store.FixWork).
| Field | Type | Description |
|---|---|---|
group_id required | string | For example 4:package_upgrade:11. |
active required | integer | Open issues that are not snoozed or accepted. For example 4. |
due required | string (date-time) or null | The earliest fix deadline of an active issue; null when none. |
overdue required | integer | For example 0. |
in_progress required | integer | Applied, waiting for a check. For example 0. |
regressed required | integer | For example 0. |
owners required | array of string | Users' emails or teams' names, most issues first, at most five. For example ["Development"]. |
unassigned required | integer | For example 0. |
mine required | integer | Open issues assigned to the caller. For example 0. |
awaiting_approval required | integer | Open issues in a pending request to ignore them. For example 0. |
FixWorkList
object
Every fix asked for that has open issues the caller can see.
| Field | Type | Description |
|---|---|---|
items required | array of FixWork | |
total required | integer | Matches in all pages. For example 42. |
limit | integer | Page size (default 100, at most 500); absent when 0. |
offset | integer | Items skipped; absent when 0. |
FixPlanSummary
object
Counts of the action plan, with the same fix in several places counted once when grouped by fix (internal/store.FixPlanSummary), and the focus view.
| Field | Type | Description |
|---|---|---|
groups required | integer | For example 24. |
findings required | integer | For example 812. |
by_kind required | map of map of integer | Per fix kind: groups and findings. For example {"security_updates":{"findings":610,"groups":4}}. |
sos required | integer | Fixes with an SOS issue. |
sos_findings required | integer | |
unique_issues required | integer | Distinct keys across all fixes. |
fixable_findings required | integer | Findings a routine update resolves today (security updates, kernel cleanup, package upgrades). |
by_priority required | map of integer | Fixes by their most urgent issue. For example {"P1":6,"P2":11}. |
overdue required | integer | Fixes with an active issue past its fix deadline. |
exploited required | integer | Fixes with a known exploited issue. |
urgent_findings required | integer | P1 and P2 findings of all the fixes. |
focus required | FixFocus |
FixGrouping
object
How fix lists show the same fix in several places.
| Field | Type | Description |
|---|---|---|
fix_grouping required | string | fix: one entry per fix, listing its places (the default); asset: one entry per asset and fix. One of fix, asset. |
FixApplied
object
The result of "I applied this".
| Field | Type | Description |
|---|---|---|
updated required | integer | Issues moved to in progress (applied, waiting for a check). |
check required | object | The check requested to confirm the fix (as GET /checks lists it). |
FocusAsset
object
An asset with fixes in focus.
| Field | Type | Description |
|---|---|---|
asset_id required | integer | |
asset_name required | string | |
groups required | integer | |
findings required | integer |
FixFocus
object
How many fixes need a person now, why the others are left out of that view, and which assets the focus fixes are on (internal/store.FixFocus).
| Field | Type | Description |
|---|---|---|
groups required | integer | |
findings required | integer | |
hidden required | map of map of integer | Fixes and findings per bucket other than focus. |
assets required | array of FocusAsset |