Skip to content
These docs describe staging.zkao.io and the @zksecurity/zkao-cli@next release. For production, see docs.zkao.io.

List advisories

View .md
GET
/projects/{projectId}/advisories
curl --request GET \
--url 'https://zkao.io/api/v1/projects/example/advisories?page=1&limit=50&status=DRAFT' \
--header 'Authorization: Bearer <token>'

Requires scope: read. The project’s coordinated-disclosure advisories, newest first. Optionally filter by status. A repository-restricted token sees an advisory only when every associated repository is in its allowlist.

projectId
required
string
page
integer
default: 1 >= 1
limit
integer
default: 50 >= 1 <= 100
status
string
Allowed values: DRAFT SCHEDULED UNDER_EMBARGO PUBLISHED WITHDRAWN

Only advisories in this status.

OK

Media typeapplication/json
object
items
required
Array<object>
object
publicId
required

Readable identifier, e.g. ADVISORY-ADV-2026-0045.

string
title
required
string
severity
required
string
Allowed values: CRITICAL HIGH MEDIUM LOW INFO
status
required
string
Allowed values: DRAFT SCHEDULED UNDER_EMBARGO PUBLISHED WITHDRAWN
disclosureAt

When the embargo lifts. Null until a date is set.

string | null format: date-time
publishedAt
string | null format: date-time
cveId
string | null
ghsaId

The GitHub advisory, once one has been filed.

string | null
ghsaUrl
string | null
ghsaState
required

What GitHub reports. A created entry is a DRAFT, which is private and reaches no scanner; only a published one is public.

string
createdAt
required
string format: date-time
page
required
integer
limit
required
integer
total
required
integer
Example
{
"items": [
{
"severity": "CRITICAL",
"status": "DRAFT"
}
]
}

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

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.

integer
Example
{
"error": {
"code": "unauthorized"
}
}

Missing, malformed, expired, or revoked token

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

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.

integer
Example
{
"error": {
"code": "unauthorized"
}
}

The token lacks the required scope

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

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.

integer
Example
{
"error": {
"code": "unauthorized"
}
}

Resource not in this token’s project or repo allowlist

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

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.

integer
Example
{
"error": {
"code": "unauthorized"
}
}