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 Projects API

Manage scanning projects and their configuration

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

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

This API exposes 12 operations across 5 paths, and defines 8 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.

12 operations 5 paths 8 schemas 2 DELETE5 GET3 POST2 PUT

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 Projects 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 12

Across 5 paths, the API surfaces 12 operations — 2 DELETE, 5 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Projects 12

Manage scanning projects and their configuration

GET
/projects
Checkmarx List projects
listProjects 6 params → 200401
POST
/projects
Checkmarx Create a project
createProject body → 201400401
GET
/projects/{projectId}
Checkmarx Get project details
getProject 1 param → 200401404
PUT
/projects/{projectId}
Checkmarx Update a project
updateProject 1 param body → 204400401404
DELETE
/projects/{projectId}
Checkmarx Delete a project
deleteProject 1 param → 204401404
GET
/projects/{projectId}/sourceCode/remoteSettings/git
Checkmarx Get Git remote source settings
getProjectGitSettings 1 param → 200401404
POST
/projects/{projectId}/sourceCode/remoteSettings/git
Checkmarx Set Git remote source settings
setProjectGitSettings 1 param body → 204400401
GET
/risk-management/projects
Checkmarx List all projects
listProjects → 200401
POST
/risk-management/projects
Checkmarx Create a new project
createProject body → 201400401
GET
/risk-management/projects/{projectId}
Checkmarx Get project details
getProject 1 param → 200401404
PUT
/risk-management/projects/{projectId}
Checkmarx Update a project
updateProject 1 param body → 204400401404
DELETE
/risk-management/projects/{projectId}
Checkmarx Delete a project
deleteProject 1 param → 204401404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Project_3 (11 properties), Project (10 properties), CreateProjectRequest (7 properties), UpdateProjectRequest (6 properties). Each schema is shown below with its type and property counts.

ProjectListResponse
object
3 properties
GitSettings
object
3 properties 2 required
CreateProjectRequest_3
object
2 properties 1 required
Project
object
10 properties
CreateProjectRequest
object
7 properties 1 required
UpdateProjectRequest
object
6 properties
UpdateProjectRequest_3
object
2 properties
Project_3
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkmarx-projects-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 Queries API
Checkmarx Reports API
Checkmarx Results API
Checkmarx Risk Reports API
Checkmarx Scans API