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

Get a regression test attempt

View .md
GET
/projects/{projectId}/findings/{findingId}/regression-tests/{runId}
curl --request GET \
--url https://zkao.io/api/v1/projects/example/findings/example/regression-tests/example \
--header 'Authorization: Bearer <token>'

Requires scope: read. Poll this run independently of the original scan.

projectId
required
string
findingId
required
string

The finding id, or the ZK- label shown on the finding page (the id’s last eight characters, prefix optional). A label that matches more than one finding in the project is refused with 409 conflict; use the full id.

runId
required
string

OK

Media typeapplication/json
object
id
required
string
findingId
required
string
status
required
string
Allowed values: QUEUED RUNNING BLOCKED READY PUBLISHED PUBLICATION_FAILED FAILED CANCELLED
creditBudget
required
integer
>= 1
targetBranch
required
string
targetCommit
required
string
auditedCommit
required
string
summary
required
string | null
pullRequestUrl
required
string | null format: uri
audited
required
Any of:
object
commit
required
string
/^[a-f0-9]{40}$/
outcome
required
string
Allowed values: assertion_failed passed blocked not_run
command
required
string
summary
required
string
target
required
Any of:
object
commit
required
string
/^[a-f0-9]{40}$/
outcome
required
string
Allowed values: assertion_failed passed blocked not_run
command
required
string
summary
required
string
createdAt
required
string format: date-time
completedAt
required
string | null format: date-time
Example
{
"status": "QUEUED",
"audited": {
"outcome": "assertion_failed"
},
"target": {
"outcome": "assertion_failed"
}
}

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

Rate limited. Either the token’s spend limit for the current period is reached (on launch), or the token is sending too many requests. Wait the number of seconds in the Retry-After header before retrying.

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"
}
}
Retry-After
integer

Seconds to wait before retrying.