Developer documentation
Code Audit Documentation
One reference for console workflows and CI/CD automation with the Code Audit external API.
The platform guide covers the main workflow from first console access to report delivery, for administrators, security owners, and delivery teams.
Get started
After signing in, confirm your Credits balance, plan limits, workspace language, and account security before creating your first audit project.
- 01Create an account and verify your email.
- 02Open the console and review Credits, concurrency, and upload limits.
- 03Create a project with a clear name and purpose for later report management.
Projects and source files
Projects organize source packages, audit tasks, and historical reports. Use clear filenames to separate versions or delivery batches.
- 01Upload a ZIP source package inside a project.
- 02Start audit tasks after the source file is ready.
- 03Delete source files that are no longer needed while preserving audit records.
Create audit tasks
An audit task binds one source file to an analysis type. After creation, the console shows queued, running, completed, or failed states.
- 01Select a source file from the project.
- 02Choose flexible mode, full mode, or another plan-enabled analysis type.
- 03Track status from the task page, and cancel or retry when needed.
Reports and collaboration
Report pages help teams review vulnerability evidence, download deliverables, and enable public sharing links when collaboration requires it.
- 01Open a completed audit from the reports list.
- 02Review severity, evidence, call stack, and remediation guidance.
- 03Download a single finding report or full report package, and enable a public link when needed.
Access and usage management
Account settings centralize API keys, billing, usage, and security controls. Production integrations should use dedicated keys and rotate them regularly.
- 01Create integration keys from the API keys page.
- 02Track Credits consumption, concurrency, and upload limits from usage pages.
- 03Manage subscription, payment, and renewal status from billing.