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

Query open source package information

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

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

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

1 operations 1 paths 2 schemas 1 GET

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 Packages 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 1

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

Packages 1

Query open source package information

GET
/packages/{packageType}/{packageName}/{version}
Checkmarx Get package details
getPackageDetails 3 params → 200401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Vulnerability (11 properties), PackageDetails (6 properties). Each schema is shown below with its type and property counts.

Vulnerability
object
11 properties
PackageDetails
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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