API reference Inventory
Inventory
List assets
GET /assets
List assets. reboot_required=true lists hosts that run older code than is installed. exposed=true or false filters by exposed, the exposure risk scoring uses: internet_exposed when set by hand, else what a collector observed (a Kubernetes workload's exposure, or for an image the workloads deployed as it). unfiled=true lists the assets in no active project. Each asset has projects, the active projects it is in that the caller can see
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
kind | query | string | |
environment | query | string | |
status | query | string | |
owner_team_id | query | string | |
q | query | string | |
reboot_required | query | string | |
exposed | query | string | |
unfiled | query | string | |
limit | query | string | Page size (default 100, at most 500) |
offset | query | string | Items to skip |
Responses
Asset and identifiers
GET /assets/{id}
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Responses
| Status | Meaning | Body |
|---|---|---|
2XX | Success | AssetDetail |
4XX | An error | Error |
5XX | An error | Error |
Set name, environment, owner, criticality, exposure, tags, expected reporting
PATCH /assets/{id}
Set name, environment, owner, criticality, exposure, tags, expected reporting (report_override: auto, daily, weekly or one_off)
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Request body
application/json, required: object
Responses
Delete an asset and its history
DELETE /assets/{id}
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Responses
Check the whole asset again
POST /assets/{id}/check
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Request body
application/json, required: object
Responses
The asset's collection history
GET /assets/{id}/collections
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Responses
List an asset's config findings
GET /assets/{id}/config-findings
The asset's config findings with the filters of GET /config-findings, and scans: the last config check by each collector. No scan means the asset was never checked
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string | |
status | query | string | open (the default), resolved or all |
severity | query | string | high, medium, low or info, comma-separated |
category | query | string | agent_hook, ssh or ci, comma-separated |
limit | query | string | Page size |
offset | query | string | Page offset |
Responses
The asset's coverage ledger
GET /assets/{id}/coverage
Coverage ledger, collection history, relations
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string | |
limit | query | string | Page size (default 100, at most 500) |
offset | query | string | Items to skip |
Responses
How far the asset's findings can be trusted
GET /assets/{id}/coverage-summary
How far the asset's findings can be trusted: its coverage states with reasons, components by coverage, gap reasons and stale feeds
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Responses
Components whose versions differ from another asset
GET /assets/{id}/drift
Components whose versions differ from another asset (with, or the asset this one is a replica_of). Each item is behind, ahead, differs, only_here or only_there, compared by the component's ecosystem rules
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string | |
with | query | string |
Responses
Components on the asset, with evidence and coverage
GET /assets/{id}/inventory
Components on the asset, with evidence and coverage (see below)
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string | |
q | query | string | |
type | query | string | |
direct | query | string | |
include_removed | query | string | |
update_type | query | string | patch, minor, major or any: only rows with a newer stable release of that update type (registry packages only; not findings) One of patch, minor, major, any. |
coverage | query | string | |
unchecked | query | string | One reason components were not checked: unreadable_version, unsupported, waiting_for_data or no_advisories |
limit | query | string | Page size (default 100, at most 500) |
offset | query | string | Items to skip |
Responses
An asset's leaked keys and its last key scans
GET /assets/{id}/leaks
The asset's leaked keys, and scans: the last key scan by each collector, whether it was complete and why not. No scan means its files were never checked
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string | |
status | query | string | open (default), resolved or all |
severity | query | string | critical, high, medium or low |
limit | query | string | Page size |
offset | query | string | Page start |
Responses
Suggested links between an application and the repository it was probably built from
GET /assets/{id}/link-suggestions
For an application with no built_from relation: up to three repositories it was probably built from, best first. For a repository: the applications that have it among their suggestions. Each item has application and repository (id, name), score (0 to 1; shown from 0.45), same_package_name, dependency_match_percent, dependencies_matched, dependencies_compared and similar_name. Dismissed pairs are left out
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Responses
Link the application to the suggested repository
POST /assets/{id}/link-suggestions/{other}/accept
Adds the built_from relation between the application and the repository ({id} and {other}, in either order), with source confirmed:<who>, and records an audit event. Needs the engineer role on both assets, as adding a relation does
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string | |
other required | path | string |
Responses
Dismiss a suggested link
POST /assets/{id}/link-suggestions/{other}/dismiss
Records that the application is not built from the repository, so the pair is not suggested again. Needs the engineer role on both assets
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string | |
other required | path | string |
Responses
The asset's relations to other assets
GET /assets/{id}/relations
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Responses
Add a relation to another asset
POST /assets/{id}/relations
Add or remove runs_on, built_from, deployed_as, contains, depends_on, replica_of (a standby, staging or DR copy that should run the same versions as the target)
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Request body
application/json, required: object
Responses
Remove a relation to another asset
DELETE /assets/{id}/relations
Add or remove runs_on, built_from, deployed_as, contains, depends_on, replica_of (a standby, staging or DR copy that should run the same versions as the target)
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Request body
application/json, required: object
Responses
Remediation actions for an asset (licensed edition; empty in Community)
GET /assets/{id}/remediation
Remediation actions for an asset
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Responses
Create the host-bound agent token used for remediation (licensed edition)
POST /assets/{id}/remediation-token
Collector token bound to this host, required for remediation
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Request body
application/json, required: object
Responses
CycloneDX 1.6 export
GET /assets/{id}/sbom
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Responses
Everything the asset relies on, followed through relations, with open findings grouped by layer
GET /assets/{id}/stack
Everything the asset relies on, followed through relations, with open findings grouped by layer (web_server, cms, os, runtime, data_store, libraries, declared, managed_service, platform, other). For an application this is its hosts, repository, images and dependencies (up to three hops); for a host, the applications running on it; for a cluster, its workloads and their images; for an image, the workloads deployed as it; for a repository, its deployments and their hosts
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Responses
Components, searchable
GET /components
Component explorer
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
q | query | string | |
type | query | string | |
segment | query | string | One segment of the coverage headline: checked, needs_you, waiting, not_supported or no_advisories |
limit | query | string | Page size (default 100, at most 500) |
offset | query | string | Items to skip |
Responses
One component
GET /components/{id}
Component explorer
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Responses
Release data (latest stable, publish date, deprecation) and lifecycle cycles
GET /components/{id}/intel
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Responses
An upgrade recommendation for each installed version with open findings
GET /components/{id}/upgrade
An upgrade recommendation for each installed version with open findings (most findings first, at most 50; total counts all), with version, distro and asset_count
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Responses
Asset identity conflicts
GET /conflicts
Resolve asset identity conflicts by merging assets. The answer lists projects_joined and grants_moved, with a notice, when the kept asset joins the merged assets' projects or takes their access grants
Responses
Resolve an identity conflict by merging assets
POST /conflicts/{id}/resolve
Resolve asset identity conflicts by merging assets. The answer lists projects_joined and grants_moved, with a notice, when the kept asset joins the merged assets' projects or takes their access grants
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Request body
application/json, required: object
Responses
Coverage ledger across assets
GET /coverage
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
problems | query | string | |
asset_id | query | string | One asset |
limit | query | string | Page size (default 100, at most 500) |
offset | query | string | Items to skip |
Responses
Assets by share checked, worst first
GET /coverage/assets
Assets by share checked, worst first, with groups counting every group (failed_collection, not_reporting, partly_checked, awaiting_first_check, healthy). Each item has components, checked, not_checked by who acts, problem_scopes, reporting and last_report
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
group | query | string | One group |
limit | query | string | Page size (default 100, at most 500) |
offset | query | string | Items to skip |
Responses
Coverage headline: components by segment, and ecosystems found
GET /coverage/overview
Coverage headline: total components on current assets split into segments (checked, needs_you, waiting, not_supported, no_advisories) that add up to total; GET /components?segment= lists each. ecosystems are the ecosystems and operating systems found, each with key, label, components, checked, not_supported, status (checked, partly or not_supported) and requested
Responses
Ask for an ecosystem to be supported
POST /coverage/support-requests
Ask for an ecosystem to be supported: {"ecosystem"}, a key from GET /coverage/overview with components Stackurity does not check. One request per workspace and ecosystem; asking again changes nothing. 400 for an ecosystem not found unsupported on your assets. Dashboard sessions only (API tokens get 403); at most 10 a minute and 50 a day per person (429)
Request body
application/json, required: object
Responses
Components not checked, by reason and who acts
GET /coverage/unchecked
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
asset_id | query | string | One asset |
Responses
Components that could not be evaluated, one entry per component and reason, with coverage
GET /evaluation-gaps
Components that could not be evaluated, one entry per component and reason, with coverage (unsupported or not_evaluated)
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
limit | query | string | Page size (default 100, at most 500) |
offset | query | string | Items to skip |
Responses
Distinct environments, asset kinds and component types
GET /facets
Responses
Where a component is used
GET /inventory
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
component_id | query | string | |
asset_id | query | string | |
coverage | query | string | |
unchecked | query | string | One reason components were not checked: unreadable_version, unsupported, waiting_for_data or no_advisories |
q | query | string | Search |
type | query | string | Component type |
direct | query | string | true or false: direct dependencies only, or transitive only |
include_removed | query | string | true: include removed rows |
update_type | query | string | patch, minor, major or any: only rows with a newer stable release of that update type (registry packages only; not findings) One of patch, minor, major, any. |
limit | query | string | Page size (default 100, at most 500) |
offset | query | string | Items to skip |
Responses
Updates available: installs behind their latest stable release
GET /inventory/updates
Updates available: installs older than their package's latest stable release, whether or not a vulnerability is involved (they are never findings). counts gives installs by update_type (patch, minor, major, total), components the packages with any install behind, top the packages with the most installs behind (component_id, type, namespace, name, installed_versions, latest_stable, update_type, installs, assets)
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
asset_id | query | string | Only this asset |
update_type | query | string | patch, minor, major or any: only list packages with this update type (counts are not filtered) One of patch, minor, major, any. |
limit | query | string | Packages listed (default 20, at most 100) |
Responses
Inventory, coverage and status counts, including assets by coverage state
GET /overview
Inventory, coverage and status counts, including assets by coverage state (asset_coverage) and components by row coverage (component_coverage)
Responses
Search the organisation
GET /search
Global search of the current workspace, see Search
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
q | query | string | |
limit | query | string |