Get an advisory
const url = 'https://zkao.io/api/v1/projects/example/advisories/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://zkao.io/api/v1/projects/example/advisories/example \ --header 'Authorization: Bearer <token>'Requires scope: read. The advisory, the software it concerns, the versions it affects, and the notices planned for it. Every associated repository must be in the token’s allowlist.
software is what decides the audience: a contact is notified about an advisory only when they run some of it. affected is a separate statement about versions, and is often empty.
A notice the plan is holding back carries blockedReason. The commonest one is that no affected range names a fixed version, which only the people who shipped the release can supply; record it in the app and the notice becomes schedulable.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”The advisory’s readable identifier.
Responses
Section titled “ Responses ”OK
object
object
Readable identifier, e.g. ADVISORY-ADV-2026-0045.
When the embargo lifts. Null until a date is set.
The GitHub advisory, once one has been filed.
What GitHub reports. A created entry is a DRAFT, which is private and reaches no scanner; only a published one is public.
The software the advisory is about. A contact hears about it only when they run some of it.
object
object
object
First version carrying the defect.
Version that closes the range. Null while no patch exists, which is what holds a patch notice back.
object
Days relative to disclosure. Negative is before it, 0 is the day itself.
Why the plan is holding this notice back, if it is.
Contacts written to, as recorded when it went.
Example
{ "advisory": { "severity": "CRITICAL", "status": "DRAFT", "notices": [ { "status": "DRAFT" } ] }}Missing, malformed, expired, or revoked token
object
object
Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.
Example
{ "error": { "code": "unauthorized" }}The token lacks the required scope
object
object
Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.
Example
{ "error": { "code": "unauthorized" }}Resource not in this token’s project or repo allowlist
object
object
Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.
Example
{ "error": { "code": "unauthorized" }}