- Checkmarx Documentation
- Checkmarx One
- Checkmarx One API Documentation
- Checkmarx One API Endpoints
Checkmarx One API Endpoints
Notice
A comprehensive Checkmarx One API Reference Guide is now available here.
The Checkmarx One external APIs are grouped into the following categories:
API Category | Description |
---|---|
These APIs enable users to perform all CRUD activities on Applications. They are also used to get various types of data about the Applications in your account. There are also APIs for CRUD activities on “rules” which define how Projects are associated with Applications. | |
This API enables you to get a list of all events that occurred in your tenant account over a specified period of time. | |
Uses your Refresh Token (i.e., API Key) or username and password to obtain an Access Token which is used for authentication of your Checkmarx One API calls during the current session. | |
For vulnerabilities identified by SAST scans, the BFL API gets info about the most effective location for fixing the vulnerabilities. This enables you to speed up your remediation by fixing multiple vulnerabilities at once. | |
Ceresults | FOR INTERNAL USE |
Configuration | FOR INTERNAL USE |
Contributors | FOR INTERNAL USE |
Feature Flag | FOR INTERNAL USE |
This API enables you to get comprehensive results for the vulnerabilities identified by the KICS scanner in a specific scan. | |
KICS Results Predicates | These APIs enable you to manage vulnerabilities identified by Kics throughout your SDLC. For each instance of a vulnerability you can adjust the predicate attributes of state, severity and notes associated with it. Each vulnerability instance is identified by a “similarity_id”. If a subsequent scan discovers a vulnerability with the identical similarity_id, its status will be marked as a “recurrent” vulnerability, and the state, severity and notes from the previous scan will be applied to the new scan. |
Logs | FOR INTERNAL USE |
These APIs enable users to perform all CRUD activities on projects. They are also used to get various types of data about the projects in your account. | |
Repostore | FOR INTERNAL USE |
Resource Management | FOR INTERNAL USE |
These APIs enable you to get a summary of the scan results for a particular group of scans. This includes the number of vulnerabilities identified in the scan, broken down by severity level, status, query name, etc. | |
These APIs are used to get information about the running of a scan. This includes detailed info about how incremental scans were executed. | |
SAST Queries | FOR INTERNAL USE |
SAST Queries Audit | FOR INTERNAL USE |
This API enables you to get comprehensive results for the vulnerabilities identified by the SAST scanner in a specific scan. | |
These APIs enable you to manage vulnerabilities identified by SAST throughout your SDLC. For each instance of a vulnerability you can adjust the predicate attributes of state, severity and notes associated with it. Each vulnerability instance is identified by a “similarity_id”. If a subsequent scan discovers a vulnerability with the identical similarity_id, its status will be marked as a “recurrent” vulnerability, and the state, severity and notes from the previous scan will be applied to the new scan. | |
This API enables you to get comprehensive results for the vulnerabilities identified by all scanners (SAST, KICS, SCA) in a specific scan. | |
These APIs are used to run, cancel or delete scans. They are also used to get various types of data about scans that have been run in the account. | |
These APIs are used for uploading zip archives to the cloud for scanning. | |
WebhooksCheckmarx One API - Webhooks | Webhooks are used to trigger external activities when specified events occur in Checkmarx One (e.g., successful scan or failed scan). The Webhooks APIs enable users to perform all CRUD activities on Webhooks. They are also used to get various types of data about the Webhooks in your account. |