Skip to main content
GET
Get advisory record
Request include=software_releases to return up to 100 current registry-observed releases assessed against this advisory’s normalized affected ranges in ecosystem-correct version order. The nested aggregate is filtered to this advisory and reports source count, conflict state, totals, limits, and truncation. This projection is distinct from affected_releases, which retains source-specific advisory metadata.

Authorizations

Authorization
string
header
required

Send the API key as Authorization: Bearer .

Headers

X-API-Version
enum<string>
default:2026-08-19

API contract version. Omit to use the latest public version. Current supported value: 2026-08-19.

Available options:
2026-08-19

Path Parameters

id
string
required

A versioned publisher-issued security notice that may describe multiple vulnerabilities, affected software, product status, fixes, and mitigations.

Example:

"GHSA-jfh8-c2jp-5v3q"

Query Parameters

include
enum<string>[]

Repeat to request typed detail projections.

Available options:
overview,
affected_targets,
risk,
remediation,
affected_releases,
software_releases,
prevention_examples,
security_activity,
execution_defenses,
relationship_summary,
relationships,
provenance
relationship_entity
enum<string>

Page one related entity type. Requires include=relationships.

Available options:
vulnerability,
advisory,
weakness,
software,
attack-pattern
relationship_limit
integer
default:12

Limit results for relationship_entity. Requires include=relationships and relationship_entity.

Required range: 1 <= x <= 100
relationship_cursor
string

Continue paging relationship_entity. Requires include=relationships and relationship_entity.

Required string length: 1 - 4096

Response

The normalized advisory record.

data
object[]
required
_meta
object
required