Connect
- Create an OAuth client in Checkmarx One. Grant the read and write permissions your workflows need. Tenants using the new access management model also require authorization for the relevant projects and applications.
- In Serval, add Checkmarx One and enter its region, tenant name, client ID, and client secret. Use your sign-in URL to distinguish US from US2 and EU from EU2.
- Run Read projects and Read scans. These checks request at most one record and do not write data. An empty response does not prove access to existing resources; successful reads do not prove permission to create scans or change findings.
Supported actions
- Create, read, update and delete projects and applications; associate projects with applications.
- Start scans from Git; read status and execution details; cancel or delete scans.
- Read findings, summaries and policy evaluations; update and read back SAST, IaC, SCA and supply-chain finding triage; list custom states.
- Generate scan reports in PDF, JSON or CSV and retrieve the completed report’s download URL.
Run a security review
Create or select a project, then start a scan with its project ID, Git repository and branch or commit. For a private repository, save its token or SSH key in Checkmarx project settings first. Inline repository credentials and credential-bearing URLs are rejected before the action is recorded. Engine settings accept documented nonsecret options only. Upload scans are not supported because their signed URLs would be recorded in workflow history. Retain the returned scan ID and poll that exact scan with bounded waits. Creation means the scan was queued, not that it passed. Handle partial, failed and canceled scans explicitly. Read its findings and policy evaluation; the workflow owns severity thresholds, required engines and approvals. Use the finding’s project and similarity IDs when triaging it. IaC updates also require the scan ID. Supply a comment and either a state or custom state ID. Read the triage history back to confirm the change. Report creation returns a job ID. Poll withreturnUrl: true until completed, then use the returned URL when provided. Authenticated MinIO downloads are not supported; use the Checkmarx UI when there is no standalone download URL. Do not send Checkmarx credentials to the download URL. After an uncertain create response, check the provider before retrying to avoid duplicate scans or reports.
Pagination and permissions
List calls return one page, defaulting to 100 records with a maximum of 1,000. Advance project, application and scan offsets by the page size. For/api/results, advance offset by 1, keeping limit fixed. A page is not a complete inventory, and missing severity counters are not zero.
Policy evaluation requires both scanId and astProjectId. A pending evaluation, empty policy list or false breakBuild alone is not approval.
For authentication errors, check the region, tenant, client ID and secret expiration. For empty data or forbidden writes, check the client’s roles and resource authorization. Back off on rate limits. Custom hosts, legacy CxSAST and India 2 are not currently supported.
See the Checkmarx One API documentation.
