CxSAST (REST) API Summary

This section provides a basic summary of our CxSAST (REST) API offering. CxSAST (REST) APIs are grouped according to their product area and each API has a direct link to the relevant API documentation. Cx version, indicating when the API was first introduced, as well as the API version is also indicated.

GroupAPICx Ver.API Ver.
LoginPOST /auth/login8.6.0 up0.1/1.0/1.1/2.0
Projects

































GET /projects

8.6.0 up

1.0/2.0

POST /projects

8.6.0 up

1.0/2.0

GET /projects/{id}

8.6.0 up

1.0/2.0

PUT /projects/{id}

8.8.0 up

1.0/2.0

PATCH /projects/{id}

8.7.0 up

1.0/2.0

DELETE /projects/{id}

8.7.0 up

1.0/2.0

POST /projects/{id}/branch

8.8.0 up

1.0

GET /issueTrackingSystems

8.7.0 up

1.0

GET /issueTrackingSystems/{id}/metadata

8.7.0 up

1.0

GET /projects/{id}/sourceCode/excludeSettings

8.7.0 up

1.0

PUT /projects/{id}/sourceCode/excludeSettings

8.7.0 up

1.0

GET /projects/{id}/sourceCode/remoteSettings/git

8.7.0 up

1.0

POST /projects/{id}/sourceCode/remoteSettings/git

8.6.0 up

1.0

GET /projects/{id}/sourceCode/remoteSettings/svn

8.7.0 up

1.0

POST /projects/{id}/sourceCode/remoteSettings/svn

8.6.0 up

1.0

GET /projects/{id}/sourceCode/remoteSettings/tfs

8.6.0 up

1.0

POST /projects/{id}/sourceCode/remoteSettings/tfs

8.6.0 up

1.0

GET /projects/{id}/sourceCode/remoteSettings/custom

8.7.0 up

1.0

POST /projects/{id}/sourceCode/remoteSettings/custom

8.7.0 up

1.0

GET /projects/{id}/sourceCode/remoteSettings/shared

8.7.0 up

1.0

POST /projects/{id}/sourceCode/remoteSettings/shared

8.6.0 up

1.0

GET /projects/{id}/sourceCode/remoteSettings/perforce

8.7.0 up

1.0

POST /projects/{id}/sourceCode/remoteSettings/perforce

8.6.0 up

1.0

POST /projects/{id}/sourceCode/remoteSettings/git/ssh

8.6.0 up

1.0

POST /projects/{id}/sourceCode/remoteSettings/svn/ssh

8.6.0 up

1.0

POST /projects/{id}/sourceCode/attachments

8.6.0 up

1.0

GET /customTasks

8.7.0 up

1.0

GET /customTasks/{id}

8.7.0 up

1.0

GET /customFields

8.8.0 up

1.0

POST /projects/{id}/dataRetentionSettings

8.7.0 up

1.0

POST /projects/{id}/issueTrackingSettings/jira

8.7.0 up

1.0

GET /sast/presets

8.6.0 up

1.0

GET /sast/presets/{id}

8.6.0 up

1.0

Scans













GET /sast/scans

8.8.0 up

1.0

POST /sast/scans

8.6.0 up

1.0

GET /sast/scans/{id}

8.6.0 up

1.0

PATCH /sast/scans/{id}

8.7.0 up

1.0

DELETE /sast/scans/{id}

8.8.0 up

1.0

GET /sast/scans/{id}/resultsStatistics

8.8.0 up

1.0

GET /sast/scansQueue/{id}

8.7.0 up

1.0

PATCH /sast/scansQueue/{id}

8.7.0 up

1.0

GET /sast/scansQueue

8.5.0 up

0.1/1.0

GET /sast/scanSettings/{projectId}

8.6.0 up

1.0/1.1

POST /sast/scanSettings

8.6.0 up

1.0/1.1

PUT /sast/scanSettings

8.7.0 up

1.1

PUT /sast/project/{projectId}/scheduling

8.8.0 up

1.0

Scan ResultsPOST /sast/results/tickets

8.8.0 up

1.0


POST /sast/projects/{id}/publisher/policyFindings8.9.0 up1.0 

GET /sast/projects/{id}/publisher/policyFindings/status8.9.0 up1.0

Scan Reports



GET /reports/sastScan/{id}

8.6.0 up

1.0

GET /reports/sastScan/{id}/status

8.6.0 up

1.0

POST /reports/sastScan

8.6.0 up

1.0

Engines







GET /sast/engineServers

8.5.0 up

0.1/1.0

POST /sast/engineServers

8.5.0 up

0.1/1.0

DELETE /sast/engineServers/{id}

8.5.0 up

0.1/1.0

GET /sast/engineServers/{id}

8.5.0 up

0.1/1.0

PUT /sast/engineServers/{id}

8.5.0 up

0.1/1.0

GET /sast/engineConfigurations

8.6.0 up

1.0

GET /sast/engineConfigurations/{id}

8.6.0 up

1.0

QueriesGET /Queries/{queryid}/CxDescription8.6.0 up1.0
Managing UsersGET /auth/teams8.6.0 up1.0
Data Retention



POST /sast/dataRetention/stop

8.8.0 up

1.0

POST /sast/dataRetention/byDateRange

8.8.0 up

1.0

POST /sast/dataRetention/byNumberOfScans

8.8.0 up

1.0

GET /sast/dataRetention/{requestId}/status8.9.0 up 1.1
Open Source Analysis






GET /osa/scans

8.4.2 up

1.0/2.0

GET /osa/scans/{scanId}

8.4.2 up

1.0/2.0

POST /osa/scans

8.4.2 up

1.0/2.0

GET /osa/fileextensions

8.6.0 up

1.0

GET /osa/licenses

8.6.0 up

1.0

GET /osa/libraries

8.6.0 up

1.0/2.0

GET /osa/vulnerabilities

8.4.2 up

1.0

GET /osa/reports

8.4.2 up

1.0

To access a live Swagger environment navigate to: http://<ServerName>/cxrestapi/help/swagger/ui/index (e.g. http://localhost/cxrestapi/help/swagger/ui/index)