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

Manage project and organization settings

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

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

This API exposes 2 operations across 1 path, and defines 1 schema. 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.

2 operations 1 paths 1 schemas 1 GET1 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 Settings 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 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Settings 2

Manage project and organization settings

GET
/settings/projects/{projectId}
Checkmarx Get project settings
getProjectSettings 1 param → 200401404
PUT
/settings/projects/{projectId}
Checkmarx Update project settings
updateProjectSettings 1 param body → 204400401404

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ProjectSettings (3 properties). Each schema is shown below with its type and property counts.

ProjectSettings
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkmarx-settings-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