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

List incoming reports

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

Requires scope: read. Vulnerability reports the programme has received, newest first. Optionally filter by status.

publicId is what investigateReport takes. intakeState says whether the report has been read and split into claims yet: an investigation waits for COMPLETE, so a PENDING or RUNNING report is one to come back to rather than one to retry.

projectId
required
string
page
integer
default: 1 >= 1
limit
integer
default: 50 >= 1 <= 100
status
string
Allowed values: NEW TRIAGING NEEDS_INFO ACCEPTED DUPLICATE REJECTED

Only reports in this triage status.

OK

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

The identifier investigateReport takes.

string
title
required
string
source
required

How it arrived, including GitHub private reports, API submissions, and file imports.

string
claimedSeverity
One of:
string
Allowed values: CRITICAL HIGH MEDIUM LOW INFO
status
required
string
Allowed values: NEW TRIAGING NEEDS_INFO ACCEPTED DUPLICATE REJECTED
intakeState
required

Whether the report has been read and split into claims. An investigation waits for COMPLETE.

string
Allowed values: PENDING RUNNING REVIEW COMPLETE FAILED
evaluationState

How the investigation is going, or null if none has run.

string | null
Allowed values: QUEUED RUNNING COMPLETE FAILED
reporterName
string | null
reporterGithubLogin
string | null
githubUrl

The GitHub advisory it arrived as.

string | null
acknowledgedAt
string | null format: date-time
createdAt
required
string format: date-time
page
required
integer
limit
required
integer
total
required
integer
Example
{
"items": [
{
"claimedSeverity": "CRITICAL",
"status": "NEW",
"intakeState": "PENDING",
"evaluationState": "QUEUED"
}
]
}

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"
}
}