Skip to content

The caller's units with their latest report, a page at a time

GET
/v1/orgs/{org}/units
curl --request GET \
--url 'https://example.com/v1/orgs/example/units?delivery=online&upgrade=any&limit=50' \
--header 'Authorization: Bearer <token>'

By unit ID (byte order), without packages: package_count says how many /units/report lists. Up to 200 units a page, 50 by default; while more is true, ask again with after set to next. The filters combine. /units/stats has the counts.

org
required
string

Organization (tenant) slug, e.g. alpenrobotik

q
string
<= 200 characters

Part of the unit ID, of the release it reported or of one of its packages’ names, any case

delivery
string
Allowed values: online bundle
release
string

The release text the units reported, exactly

upgrade
string
Allowed values: any now waiting

Only the units whose linked release should be upgraded: it has an open finding that is affected or known exploited. now: a newer release of the same variant, with an SBOM, has none of those findings open. waiting: there is no such release yet. any: both.

limit
integer
default: 50 >= 1 <= 200
after
string

The next of the previous page

A page of units

Media typeapplication/json
object
items
required
Array<object>

A unit’s latest report without its packages, as the unit list shows it. The fields are Report’s.

object
tenant
required
string
unit_id
required
string
release
required
string
product
string
variant
string
collector_version
string
collected_at
required
string format: date-time
delivery
required
string
Allowed values: online bundle
matchable
required
boolean
release_id
string format: uuid
linked
required
boolean
linked_release
object
product_id
required
string format: uuid
product
required

The product’s name.

string
variant
required
string
version
required
string
package_count
required

The number of packages /units/report lists for the unit

integer
next

The after of the next page; absent on the last. Opaque

string
more
required

More units follow next

boolean

Example

{
"items": [
{
"delivery": "online"
}
]
}

Request.invalid (params.field q, delivery, release, upgrade, limit or after)

Missing or invalid credentials

No such organization, or the caller does not belong to it

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