Skip to content

One unit's latest report, with its packages

GET
/v1/units/report
curl --request GET \
--url 'https://example.com/v1/units/report?unit=example' \
--header 'Authorization: Bearer <token>'
unit
required
string

The unit ID, exactly

The unit

Media typeapplication/json
object
tenant

Owning tenant. Optional on input; if set it must match the caller’s organization. Always set on output.

string
unit_id
required

Unique within a tenant. Valid UTF-8 without control characters (400, report.invalid).

string
<= 255 characters
release

Release the unit runs. Collectors before the rename send it as “firmware”

string
<= 255 characters
product

Product key from PRODUCT= in the device’s release file. Optional; longer is refused (400, report.invalid).

string
<= 100 characters
variant

Variant name from VARIANT= in the device’s release file. Optional; longer is refused (400, report.invalid).

string
<= 100 characters
collector_version

Version of the collector that sent the report. Optional (older collectors don’t send it); longer is refused (400, report.invalid).

string
<= 100 characters
release_id

Output only. The organization’s release the unit’s last report names: product key, variant and version; else an alias of the version; else, without a product, the one release with that version. Absent when the report names none.

string format: uuid
linked

Output only. Whether release_id is set. A linked unit inherits its release’s VEX statements; an unlinked one is judged on its own SBOM matches only.

boolean
linked_release

Output only. The names of the release release_id points to; absent when unlinked.

object
product_id
required
string format: uuid
product
required

The product’s name.

string
variant
required
string
version
required
string
collected_at

When the inventory was taken. Required; more than 10 minutes ahead of the server’s clock is refused (400, report.invalid), since it would make every later report look older.

string format: date-time
delivery

Required on input: online (pushed) or bundle (imported). Anything else is refused (400, report.invalid).

string
Allowed values: online bundle
matchable

Output only. False when the unit’s last report had no package URLs (a collector before), so its packages aren’t matched against vulnerabilities and it doesn’t count in blast radius or triage.

boolean
packages

A report with more packages is refused (400, report.invalid).

Array<object>
<= 20000 items
object
name
string
<= 255 characters
version
string
<= 255 characters
purl

Package URL for vulnerability matching, such as pkg:deb/debian/libc6@2.36-9?arch=amd64&distro=debian-12&upstream=glibc. Optional; collectors before don’t send it, and their units aren’t matched. A PURL that doesn’t parse or is longer is ignored.

string
<= 1024 characters

Example

{
"delivery": "online"
}

Request.fieldRequired (params.field unit)

Missing or invalid API key

No such unit

Over the operation’s rate-limit budget (x-affectra-budget): code request.rateLimited with params.budget. Wait Retry-After seconds before trying again.

Media typeapplication/problem+json

Every error answer, Content-Type application/problem+json. The web app and integrations translate code; detail is English, for people reading curl output or CI logs, and may change wording at any time. Match on code, never on detail.

object
status
required

The HTTP status

integer
code
required

Stable error codes. A code is never renamed; new ones may be added, so a client falls back to detail for a code it doesn’t know. Another organization’s object answers notFound, the same as a missing one.

string
Allowed values: notFound internal request.invalidJson request.invalid request.alreadyExists request.timeInvalid auth.required auth.csrfMissing email.invalid accounts.passwordUnavailable locale.invalid request.rateLimited auth.sessionRequired auth.roleTooLow auth.githubTokenUploadOnly org.suspended org.required request.fieldRequired request.textInvalid request.timeout server.notReady catalog.unavailable report.invalid report.wrongTenant settings.csafNamespaceInvalid settings.digestHourInvalid settings.timeZoneInvalid sbom.invalid sbom.limitExceeded sbom.signatureInvalid sbom.signatureRequired sbom.signatureUnavailable upload.hardwareRevisionRenamed upload.malformed upload.unexpectedPart upload.sbomMissing upload.tooLarge upload.unreadable provenance.invalid provenance.sbomAttestation provenance.signatureRequired provenance.unavailable vex.vulnerabilityInvalid vex.statusInvalid vex.justificationUnknown vex.justificationNotAllowed vex.justificationRequired vex.actionRequired vex.statementTooLong vex.csafNamespaceRequired vex.csafNoStatements release.hasVexStatements finding.refInvalid mapping.purlInvalid mapping.purlVersioned mapping.purlCoveredByOsv mapping.cpeFieldInvalid mapping.builtIn mapping.csafProviderUnknown mapping.csafKindInvalid mapping.csafValueInvalid feeds.notSubscribable accounts.setupEmailLimit member.exists member.joined member.roleInvalid member.ownerGrantDenied member.ownerChangeDenied member.ownerRemoveDenied member.lastOwner github.orgInvalid github.teamInvalid github.roleInvalid github.adminRequired key.nameInvalid key.roleInvalid key.purposeInvalid product.keyInvalid product.keyExists product.keyLocked product.supportEndsInvalid alias.reportedInvalid alias.exists publisher.repositoryInvalid publisher.fieldTooLong publisher.idsIncomplete publisher.repositoryNotFound publisher.githubUnreachable publisher.workflowInvalid publisher.refPatternPrefix publisher.refPatternInvalid publisher.exists graph.vulnerabilityUnknown graph.timeout proposal.evidenceUnknown proposal.evidenceTooLarge proposal.kindInvalid proposal.basisInvalid proposal.notCarryOver proposal.basisMismatch proposal.notPending proposal.sourceSuperseded proposal.ownProposal proposal.fourEyes proposal.personRequired proposal.batchTooLarge proposal.vulnerabilityChanged proposal.reportedChanged proposal.releaseUnknown proposal.evidenceMissing notifications.unavailable notifications.findingsInvalid notifications.tokenInvalid webhook.urlRejected webhook.limitReached webhook.formatUnavailable webhook.headerInvalid webhook.eventTypesInvalid webhook.disabled events.cursorInvalid
detail
required

What went wrong

string
params
required

Values the code’s message needs, e.g. {“field”: “version”}. Only values the caller sent or may see. Empty when the message needs none.

object
key
additional properties
any

Example

{
"code": "notFound"
}
Retry-After
integer
>= 1

Seconds until a request would be allowed again, at least 1