Record which versions an advisory affects
const url = 'https://zkao.io/api/v1/projects/example/advisories/example/affected';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"affected":[{"repository":{"owner":"example","name":"example"},"introducedIn":"example","fixedIn":"example"}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://zkao.io/api/v1/projects/example/advisories/example/affected \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "affected": [ { "repository": { "owner": "example", "name": "example" }, "introducedIn": "example", "fixedIn": "example" } ] }'Requires scope: advisories:write. Replaces the whole set of affected ranges, so send what is affected now rather than a patch. Every existing and requested repository must be in the token’s allowlist. This check also applies to an empty replacement.
fixedIn is the point of this endpoint. A patch notice stays blocked until some range names a fixed version, and only the people who shipped the release know it.
Versions only. A range may name only software already on the advisory’s software, and anything else is a 400. Which software an advisory concerns decides who hears about it, and that is its own statement, made in the app: a call about versions does not change it in either direction.
This call never sends anything. It records versions and recomputes the disclosure plan: a notice blocked for want of a fix becomes eligible to go, and one that loses its fix is blocked again, dropping any approval it was carrying so nobody approves wording a later fix rewrites. When an eligible notice is actually sent is governed by the programme’s own settings, not by this call.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”The advisory’s readable identifier.
Request Bodyrequired
Section titled “Request Bodyrequired”object
object
object
First version carrying the defect.
Version that closes the range, or null.
Examplegenerated
{ "affected": [ { "repository": { "owner": "example", "name": "example" }, "introducedIn": "example", "fixedIn": "example" } ]}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" } ] }}Invalid request
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" }}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" }}A compare-and-set (expectedContent) missed: the guidance changed since it was read. Re-read the current guidance and retry.
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" }}