Checkmarx SCA (REST) API - POST Project

Title

POST Project

Description

Create a new Project. You need to specify the Project name and assign the Project to Teams. The response returns a unique Project ID which is used to refer to the Project when running scans or performing CRUD actions.

Method

POST

Workflow

Use POST /risk-management/projects to create a new Project.
If you would like to activate Exploitable Path, use PUT /risk-management/settings/projects/{projectId} to configure the Exploitable Path settings.
You can scan the Project using the Scan Upload APIs.

URL

US Environment - https://api-sca.checkmarx.net/risk-management/projects
EU Environment - https://eu.api-sca.checkmarx.net/risk-management/projects

Curl Sample

curl -X POST " https://api-sca.checkmarx.net/risk-management/projects" -H "accept: application/json" -d "{ "name": "Demo04", "assignedTeams": [“Team02”,"Team03"]}”

Media Type (header)

Authorization: Bearer <access_token>

Accept: application/json

Parameters

Body Parameters - Required

Parameter	Type	Enum	Description
name	string	-	The name of the Project.
assignedTeams[]	string	-	An array sprecifying the Team/s that the Project is assigned to. e.g. [“/CxServer/Team03, /CxServer/Team05”] If an empty array is submitted then all Teams can access the Project.

Parameter

Type

Enum

Description

name

string

The name of the Project.

assignedTeams[]

string

An array sprecifying the Team/s that the Project is assigned to. e.g. [“/CxServer/Team03, /CxServer/Team05”]

If an empty array is submitted then all Teams can access the Project.

Success Response

Code: 201 Created

Attributes:

Attribute	Type	Enums	Description
id	string	-	The unique identifier of the Project.
name	string	-	The name of the Project.
isManaged	boolean	True False	True if the Project is managed by GitHub. False if it is a “General” Project. Tip All Projects created via API are “General” Projects.
createdOn (nullable)	string (date-time)	-	The date and time that the Project was created.
tenantId	string	-	The unique identifier of the tenant account.
Branch (nullable)	string	-	The branch of the Project in GitHub, for GitHub Projects only.
assignedTeams[ ] (nullable)	string	-	Teams that were assigned to the Project.
lastSuccessfulScanId (nullable)	string	-	The unique identifier of the last successful scan of the Project.

Sample Success Response

{
    "id": "636622e2-db25-496b-baeb-a264bfa88309",
    "name": "Demo04",
    "isManaged": false,
    "createdOn": "2021-04-11T14:00:25.5855168Z",
    "tenantId": "89c72e33-2d07-484d-914a-6d546fe31f07",
    "branch": "master",
    "assignedTeams": [
        "/CxServer/DemoTeam03"
    ],
    "lastSuccessfulScanId": null
}

Error Response

In this section: