- Checkmarx Documentation
- Checkmarx SAST
- SAST Release Notes
- Main Releases
- Previous Main Releases
- Release Notes for 9.3.0
- 9.3.0 API Updates
9.3.0 API Updates
REST / SOAP / ODATA API
Category | Updates | Details |
---|---|---|
REST API | API Clients using REST | As part of the integration with our new Access Control, Cookie-based authentication is no longer supported and all API Clients must use Token-based authentication. |
SOAP API | API Clients using SOAP | As part of the integration with our new Access Control system, the following authentication and authorization changes are introduced:
NoticeThe SOAP SDK will be deprecated as soon as REST alternatives are available. |
ODATA API | API Clients using ODATA |
CxSAST/CxOSA APIs
General
Category | Updates | Details |
---|---|---|
CxSAST API | Overview of the CxSAST (REST) API | The CxSAST (REST) API provides the ability to manage all CxSAST related tasks. For more information, see CxSAST / CxOSA APIs - CxSAST, below. |
CxOSA API | Overview of the CxOSA (REST) API | The CxOSA (REST) API provides the ability to manage all CxOSA related tasks. For more information, see CxSAST / CxOSA APIs - CxOSA, below. |
CxSAST
Category | Updates | Details |
---|---|---|
API Versioning | Versioning was introduced to the CxSAST API in v8.6.0. The latest CxSAST APIs for v9.3.0 are installed with the most up to date API versions | |
New API Functionality | REST API to get the Best Fix Location | |
REST API to update the engine scan settings | This allows to update the following fields: Engine Name URI Minimum LOC Maximum LOC Block engine (flag) Maximum concurrent Scans | |
REST API to update result labels | This allows to update the following fields: Change state Change severity Change user assignment Add comment | |
Updated API Functionality | None | |
Updated API Documentation | None | |
CxREST API - Swagger | Login is required for exploring the CxSAST (REST) API through Swagger. To navigate to the relevant login page, click the login / authorize button. |
Management & Orchestration APIs
Analytics (OData & REST)
Category | Updates | Details |
---|---|---|
API Versioning | Versioning was introduced to the Analytics (OData) in v8.8.0. The latest Analytics (REST) APIs in v9.3.0 are installed with the latest API version. | In order to use different versions of the Analytics API you will need to specify the desired API version (Headers Content-Type) for each API call. |
Updated API Functionality | APIs have been updated in accordance with latest Analytics API library version. | |
CxAnalytics API - Swagger |
Remediation Intelligence
Category | Updates | Details |
---|---|---|
API Versioning | Versioning was introduced to the Remediation Intelligence API in v9.0.0. The latest Remediation Intelligence APIs in v9.2.0 are installed with the latest API version. | In order to use different versions of the Policy Management API you will need to specify the desired API version (Headers Content-Type) for each API call. |
New Functionality | A new functionality has been added to the latest Remediation Intelligence API library version for the API set. | |
Updated Functionality | Various APIs have been updated in accordance with the latest Remediation Intelligence API library version. | |
Policy Management API - Swagger | Login is required for exploring the Remediation Intelligence (REST) API through Swagger. To navigate to the relevant login page, click the login / authorize button. |
Policy Management
Category | Update | Details |
---|---|---|
API Versioning | Versioning was introduced to the Policy Management API in v8.8.0. The latest Policy Management APIs in v9.2.0 are installed with the latest API version. | In order to use different versions of the Policy Management API you will need to specify the desired API version (Headers Content-Type) for each API call. |
New Functionality | A new functionality has been added to the latest Policy Management API library version for the API set. | |
Updated Functionality | Various APIs have been updated in accordance with latest Policy Management API library version. | |
Policy Management API - Swagger |
Platform Services APIs
General
Category | Updates | Details |
---|---|---|
Access Control API | Overview of the Access Control (REST) API | The Access Control (REST) API provides the ability to manage all user/team management and access control setting tasks. For more information, see Platform Services APIs - Access Control, below. |
Access Control
Category | Updates | Details |
---|---|---|
API Versioning | Versioning was introduced to the Access Control API in v1.5.0. The latest Access Control APIs in v2.0.0 are installed with the latest API version (i.e., v=1.0). | In order to use different versions of the Access Control API you will need to specify the desired API version (Headers Content-Type) for each API call. |
New API Functionality | ||
Updated API Functionality | Various APIs have been updated in accordance with the latest Access Control API library version. | |
Access Control API - Swagger | To access a live Swagger environment navigate to: http://<ServerName>:<Port>/cxarm/dashboardapi/swagger/index/html (e.g., http://localhost:8080/cxrestapi/auth/swagger/index.html). | Login is required for exploring the Access Control (REST) API through Swagger. To navigate to the relevant login page, click the login / authorize button. |
.