The API reference is in English.

Current source preview reference

API reference

Endpoints, request formats and responses for the local CodeSecurity backend. Start with a workflow or find the endpoint you need.

0.1.0 · source bccff29 · Immutable snapshot · Download OpenAPI specification

Start with a task

Read the workflow, then find its routes. Check authentication and authority first.

Find a route

Browse by group below, use your browser’s find command, or search all documentation.

Diagnostics 3 Advisor 8 Artifacts 2 Authentication 19 Configuration 5 Events 1 Findings 7 Gates 2 Git protection 9 IDE source navigation 5 Jobs 5 Projects 6 Scanner preparation 10 Scans 11 Source authorization 2

Source preview and authority boundaries

The control surface contains 95 operations across 83 paths at this commit. Browser sessions and exact IDE capabilities have different authority. No generic API-key or public proxy flow is offered.

Examples are synthetic and validated against declared JSON Schema shapes. Runtime validators, state and ownership can reject an otherwise matching payload. Read authentication and export limitations.

Diagnostics 3 routesFind a route ↑

GET/healthzHealthz GET/metricsMetrics GET/v1/dashboard/summaryDashboard summary

Advisor 8 routesFind a route ↑

GET/v1/advisor/local-modelsList local advisor models GET/v1/advisor/providersList advisor providers POST/v1/advisor/providersCreate advisor provider DELETE/v1/advisor/providers/{provider_id}Delete advisor provider PUT/v1/advisor/providers/{provider_id}Replace advisor provider POST/v1/advisor/providers/{provider_id}/commandsCommand advisor provider GET/v1/advisor/providers/{provider_id}/receiptGet advisor provider receipt GET/v1/advisor/triage-request-auditAdvisor triage request audit

Artifacts 2 routesFind a route ↑

GET/v1/artifacts/{artifact_id}/downloadDownload artifact GET/v1/artifacts/{artifact_id}/openOpen artifact

Authentication 19 routesFind a route ↑

POST/v1/auth/bootstrapBootstrap POST/v1/auth/browser/pairing-tokenRotate browser pairing token GET/v1/auth/browser/sessionsList browser members DELETE/v1/auth/browser/sessions/{member_id}Revoke browser member POST/v1/auth/ide/activateActivate ide capability POST/v1/auth/ide/browser-invitationsCreate ide browser invitation GET/v1/auth/ide/browser-invitations/{invitation_id}/membershipWait for ide browser membership GET/v1/auth/ide/capabilitiesList ide capabilities DELETE/v1/auth/ide/capabilities/{capability_id}Revoke ide capability DELETE/v1/auth/ide/capabilities/{capability_id}/invalidRecover invalid ide capability DELETE/v1/auth/ide/capabilities/{capability_id}/pendingCancel pending ide capability from browser GET/v1/auth/ide/enrollmentsList pending ide enrollments POST/v1/auth/ide/enrollmentsCreate ide enrollment POST/v1/auth/ide/enrollments/current/claim-first-ownerClaim first ide owner GET/v1/auth/ide/enrollments/current/waitWait for ide enrollment decision POST/v1/auth/ide/enrollments/{request_id}/decisionDecide ide enrollment DELETE/v1/auth/ide/pendingCancel pending ide capability POST/v1/auth/logoutLogout GET/v1/auth/sessionSession

Configuration 5 routesFind a route ↑

GET/v1/configConfig PUT/v1/configUpdate config PATCH/v1/config/advisorUpdate advisor config PATCH/v1/config/componentsUpdate components config PATCH/v1/config/gateUpdate gate config

Events 1 routesFind a route ↑

GET/v1/eventsStream events

Findings 7 routesFind a route ↑

POST/v1/findings/bulkBulk findings DELETE/v1/findings/{finding_id}Delete finding GET/v1/findings/{finding_id}Get finding POST/v1/findings/{finding_id}/advisor-disclosure-previewPreview finding advisor disclosure PATCH/v1/findings/{finding_id}/lifecycleUpdate finding lifecycle GET/v1/findings/{finding_id}/packetGet packet POST/v1/findings/{finding_id}/triageTriage finding

Gates 2 routesFind a route ↑

GET/v1/gate-policies/{project_id}Get gate policy PUT/v1/gate-policies/{project_id}Update gate policy

Git protection 9 routesFind a route ↑

GET/v1/git/push-protectionList push policies POST/v1/git/push-protectionRegister push repository GET/v1/git/push-protection/{repository_id}Get push policy PATCH/v1/git/push-protection/{repository_id}Update push policy POST/v1/git/push-protection/{repository_id}/checkCheck git push POST/v1/git/push-protection/{repository_id}/members/{client_slot}/{generation}Approve push member POST/v1/git/push-protection/{repository_id}/observationObserve push hook POST/v1/git/push-protection/{repository_id}/removeRemove push repository POST/v1/git/push-protection/{repository_id}/treesUpload git tree

Jobs 5 routesFind a route ↑

GET/v1/jobsList jobs GET/v1/jobs/{job_id}Get job POST/v1/jobs/{job_id}/cancelCancel job POST/v1/jobs/{job_id}/reconcileReconcile scanner cache job POST/v1/jobs/{job_id}/retryRetry job

Projects 6 routesFind a route ↑

GET/v1/projectsList projects POST/v1/projectsCreate project POST/v1/projects/resolveResolve project DELETE/v1/projects/{project_id}Delete project GET/v1/projects/{project_id}Get project GET/v1/projects/{project_id}/scans/latestGet latest project scan

Scanner preparation 10 routesFind a route ↑

POST/v1/scanner/cache/rollbackRollback scanner cache POST/v1/scanner/cache/updateUpdate scanner cache POST/v1/scanner/cache/verification/retryRetry scanner cache verification GET/v1/scanner/lifecycleScanner lifecycle GET/v1/scanner/preflightScanner preflight POST/v1/scanner/preparePrepare scanners GET/v1/scanner/toolsScanner tools POST/v1/scanner/tools/check-latestCheck scanner tools PATCH/v1/scanner/tools/{tool_id}Patch scanner tool POST/v1/scanner/tools/{tool_id}/updateUpdate scanner tool

Scans 11 routesFind a route ↑

GET/v1/scansList scans POST/v1/scansCreate scan DELETE/v1/scans/{scan_id}Delete scan GET/v1/scans/{scan_id}Get scan GET/v1/scans/{scan_id}/artifactsList scan artifacts GET/v1/scans/{scan_id}/finding-diagnosticsList finding diagnostics GET/v1/scans/{scan_id}/finding-filesList finding files GET/v1/scans/{scan_id}/findingsList findings GET/v1/scans/{scan_id}/findings/{scan_finding_number}Get scan local finding GET/v1/scans/{scan_id}/summaryGet scan summary POST/v1/scans/{scan_id}/triageTriage scan

Source authorization 2 routesFind a route ↑

POST/v1/source-snapshotsCreate source snapshot POST/v1/sources/previewPreview source