Skip to content
zkao docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Get started
Build on zkao
Quickstart
Authentication
Environments
Guides
Run scans
Diff scans
Triage findings
Repository guidance
Credits and usage
Publish results
GitHub Action
AI agents
Reference
CLI reference
TypeScript SDK
API conventions
API reference
Endpoints
Overview
Token
Overview
The calling token and its project
Repositories
Overview
List repositories in the project
Get a repository's guidance
Set or clear a repository's guidance
List a repository's audit areas
Add a custom audit area
Delete a custom audit area
Scans
Overview
List scans (most recent first)
Launch a scan
Get a single scan's status and detail
Cancel a running or queued scan
Findings
Overview
List findings
Get a single finding (full detail)
Add a comment (note) to a finding
Pin a note as the resolution note
Override (or clear) a finding's severity
Change a finding's resolution status
Publishing
Overview
Publish a finding as a public artifact
Publish a scan as a public artifact
Discovery
Overview
List the scan presets (scan types) the project can launch
Billing
Overview
Credits available to this project
Credit usage events attributed to this project
Monthly spend and purchase summary for this project
GitHub
Select theme
Dark
Light
Auto
These docs describe
staging.zkao.io
and the
@zksecurity/zkao-cli@next
release. For production, see
docs.zkao.io
.
Overview
Publishing
Section titled “Publishing”
Publish findings and scans as public artifacts
Operations
Section titled “ Operations ”
POST
/projects/{projectId}/findings/{findingId}/publish
POST
/projects/{projectId}/scans/{scanId}/publish
