Skip to content

Every product with its variants and their newest releases

GET
/v1/orgs/{org}/catalog/overview
curl --request GET \
--url 'https://example.com/v1/orgs/example/catalog/overview?releases=6' \
--header 'Authorization: Bearer <token>'

Products by name, each with its variants by name. A variant lists its newest releases releases, newest version first (see ProductReleasePage for the order), each with its finding groups counted as in /exposure/summary; release_count is all of its releases, and older_open and older_open_kev count the releases left out that have an open finding group, and an open known-exploited one.

org
required
string

Organization (tenant) slug, e.g. alpenrobotik

releases
integer
default: 6 >= 1 <= 50

Releases per variant

Overview

Media typeapplication/json
object
products
required

By name

Array<object>
object
id
required
string format: uuid
name
required
string
description
required
string
key
required

The product key firmware reports as PRODUCT=; null until an admin sets it

string | null
support_ends
required

Last day of security updates; null when not set

string | null format: date
created_at
required
string format: date-time
variants
required

By name

Array<object>
object
id
required
string format: uuid
product_id
required
string format: uuid
name
required
string
created_at
required
string format: date-time
release_count
required

All of the variant’s releases

integer format: int64
releases
required

The newest, newest version first

Array<object>

A release with its variant and its finding groups, counted as in ReleaseExposure

object
id
required
string format: uuid
variant_id
required
string format: uuid
variant
required

The variant’s name

string
version
required
string
released_at
string format: date-time
created_at
required
string format: date-time
sboms
required
integer format: int64
verified_sboms
required

SBOMs signed by a trusted publisher

integer format: int64
open
required

CVEs (finding groups) in this release not resolved by VEX

integer format: int64
open_kev
required

Open known-exploited CVEs (finding groups)

integer format: int64
open_affected
required

Open CVEs (finding groups) with an affected VEX statement; open minus open_affected is still to assess

integer format: int64
resolved
required

CVEs (finding groups) VEX marked not_affected or fixed

integer format: int64
older_open
required

Releases not in releases with an open finding group

integer format: int64
older_open_kev
required

Releases not in releases with an open known-exploited finding group

integer format: int64

Example generated

{
"products": [
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"description": "example",
"key": "example",
"support_ends": "2026-04-15",
"created_at": "2026-04-15T12:00:00Z",
"variants": [
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"product_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"created_at": "2026-04-15T12:00:00Z",
"release_count": 1,
"releases": [
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"variant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"variant": "example",
"version": "example",
"released_at": "2026-04-15T12:00:00Z",
"created_at": "2026-04-15T12:00:00Z",
"sboms": 1,
"verified_sboms": 1,
"open": 1,
"open_kev": 1,
"open_affected": 1,
"resolved": 1
}
],
"older_open": 1,
"older_open_kev": 1
}
]
}
]
}

Request.invalid (params.field releases)

No such object in this organization, 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

The server runs without a database or object storage; the catalog is unavailable