Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Checkmarx Scans API

Trigger, monitor, and manage security scans

Checkmarx Scans API is one of 15 APIs that Checkmarx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scans. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 11 operations across 6 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against 2 base URLs: https://ast.checkmarx.net/api, https://eu.ast.checkmarx.net/api.

11 operations 6 paths 9 schemas 1 DELETE6 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://your-checkmarx-instance.com/cxrestapi
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Checkmarx Scans API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 bearer token obtained via client credentials from the Checkmarx One IAM service

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 1 DELETE, 6 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Scans 11

Trigger, monitor, and manage security scans

GET
/scans
Checkmarx List scans
listScans 5 params → 200401
POST
/scans
Checkmarx Create a new scan
createScan body → 201400401
GET
/scans/{scanId}
Checkmarx Get scan details
getScan 1 param → 200401404
DELETE
/scans/{scanId}
Checkmarx Cancel a scan
cancelScan 1 param → 204401404
GET
/sast/scans
Checkmarx List all scans
listScans 3 params → 200401
POST
/sast/scans
Checkmarx Create a new scan
createScan body → 201400401
GET
/sast/scans/{scanId}
Checkmarx Get scan details
getScan 1 param → 200401404
PATCH
/sast/scans/{scanId}
Checkmarx Update scan status
updateScanStatus 1 param body → 200401404
GET
/risk-management/scans
Checkmarx List scans
listScans 1 param → 200401
POST
/risk-management/scans
Checkmarx Trigger a new scan
createScan body → 201400401
GET
/risk-management/scans/{scanId}
Checkmarx Get scan details
getScan 1 param → 200401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Scan (13 properties), Scan_3 (7 properties), Scan_2 (7 properties), ScanResultsStatistics (5 properties). Each schema is shown below with its type and property counts.

ScanResultsStatistics
object
5 properties
CreateScanRequest
object
5 properties 3 required
CreateScanRequest_3
object
2 properties 1 required
ScanListResponse
object
3 properties
Scan_2
object
7 properties
ScanStatusDetail
object
3 properties
Scan_3
object
7 properties
CreateScanRequest_2
object
5 properties 1 required
Scan
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkmarx-scans-api-openapi.yml Raw ↑

Other APIs Checkmarx publishes across the network.

Checkmarx Applications API
Checkmarx Authentication API
Checkmarx Configuration API
Checkmarx Engines API
Checkmarx Groups API
Checkmarx Packages API
Checkmarx Presets API
Checkmarx Projects API
Checkmarx Queries API
Checkmarx Reports API
Checkmarx Results API
Checkmarx Risk Reports API