Confluence
Spaces
Apps
Templates
Create
Checkmarx Knowledge Center
All content
Space settings
Shortcuts
Checkmarx AST Documentation
Checkmarx AST Documentation
Restricted link, try another account
This trigger is hidden
Checkmarx IAST Documentation
Checkmarx IAST Documentation
Restricted link, try another account
This trigger is hidden
Content
CxSAST Release Notes
CxSAST Overview
CxSAST Set Up Guide
CxSAST Quick Start Guide
CxSAST User Guide
CxSAST Configuration Guide
Beta DAST Client Documentation
CxSAST API Guide for CxSAST Versions Before v9.4.0
CxSAST (OData) API
CxSAST (REST) API
CxSAST v9.3 (REST) API
CxSAST (REST) API Authentication
•
CxSAST (REST) API Summary
•
Using the CxSAST (REST) API (v8.6.0 and up)
CxSAST (REST) API - Login
CxSAST (REST) API - Projects
Get All Project Details - GET /projects
Create Project with Default Configuration - POST /projects
Get Project Details by Id - GET /projects/{id}
•
Get Project Details by Id - GET /projects/{id} (v8.6.0 to v8.7.0)
•
Get Project Details by Id - GET /projects/{id} (v8.8.0 and up)
Update Project by Id - PUT /projects/{id}
Update Project Name/Team Id - PATCH /projects/{id}
Delete Project by Id - DELETE /projects/{id}
•
Create Branched Project - POST /projects/{id}/branch (v8.8.0 and up)
•
Get All Issue Tracking Systems - GET /issueTrackingSystems (v8.7.0 and up)
•
Get Issue Tracking System Details by Id - GET /issueTrackingSystems/{id}/metadata (v8.7.0 and up)
•
Get Project Exclude Settings by Project Id - GET /projects/{id}/sourceCode/excludeSettings (v8.7.0 and up)
•
Set Project Exclude Settings by Project Id - PUT /projects/{id}/sourceCode/excludeSettings (v8.7.0 and up)
•
Get Remote Source Settings for GIT by Project Id - GET /projects/{id}/sourceCode/remoteSettings/git (v8.7.0 and up)
•
Set Remote Source Setting to GIT - POST /projects/{id}/sourceCode/remoteSettings/git (v8.6.0 and up)
•
Get Remote Source Settings for SVN by Project Id - GET /projects/{id}/sourceCode/remoteSettings/svn (v8.7.0 and up)
•
Set Remote Source Setting to SVN - POST /projects/{id}/sourceCode/remoteSettings/svn (v8.6.0 and up)
•
Get Remote Source Settings for TFS by Project Id - GET /projects/{id}/sourceCode/remoteSettings/tfs (v8.6.0 and up)
•
Set Remote Source Setting to TFS - POST /projects/{id}/sourceCode/remoteSettings/tfs (v8.6.0 and up)
•
Get Remote Source Settings for Custom by Project Id - GET /projects/{id}/sourceCode/remoteSettings/custom (v8.7.0 and up)
•
Set Remote Source Setting for Custom by Project Id - POST /projects/{id}/sourceCode/remoteSettings/custom (v8.7.0 and up)
•
Get Remote Source Settings for Shared by Project Id - GET /projects/{id}/sourceCode/remoteSettings/shared (v8.7.0 and up)
•
Set Remote Source Setting to Shared - POST /projects/{id}/sourceCode/remoteSettings/shared (v8.6.0 and up)
•
Get Remote Source Settings for Perforce by Project Id - GET /projects/{id}/sourceCode/remoteSettings/perforce (v8.7.0 and up)
•
Set Remote Source Setting to Perforce - POST /projects/{id}/sourceCode/remoteSettings/perforce (v8.6.0 and up)
•
Set Remote Source Setting to GIT using SSH - POST /projects/{id}/sourceCode/remoteSettings/git/ssh (v8.6.0 and up)
•
Set Remote Source Setting to SVN using SSH - POST /projects/{id}/sourceCode/remoteSettings/svn/ssh (v8.6.0 and up)
•
Upload Source Code Zip File - POST /projects/{id}/sourceCode/attachments (v8.6.0 and up)
•
Get All Custom Tasks - GET /customTasks (v8.7.0 and up)
•
Get Custom Task by Id - GET /customTasks/{id} (v8.7.0 and up)
•
Get All Custom Fields - GET /customFields (v8.8.0 and up)
•
Set Data Retention Settings by Project Id - POST /projects/{id}/dataRetentionSettings (v8.7.0 and up)
•
Set Issue Tracking System as Jira by Id - POST /projects/{id}/issueTrackingSettings/jira (v8.7.0 and up)
•
Get All Preset Details - GET /sast/presets (8.6.0 and up)
•
Get Preset Details by Preset Id - GET /sast/presets/{id} (8.6.0 and up)
CxSAST (REST) API - SAST Scans
CxSAST (REST) API - SAST Scan Results
CxSAST (REST) API - SAST Scan Reports
CxSAST (REST) API - Engines
CxSAST (REST) API - Queries
CxSAST (REST) API - Managing Users
CxSAST (REST) API - Data Retention
•
CxSAST (REST) API - Open Source Analysis (CxOSA)
CxSAST (REST) API - Swagger Examples
CxSAST (SOAP) API
•
Downloadable Documentation (CxSAST API)
CxAudit Guide
Management and Orchestration
Access Control
Plugin and Integration Guide
CxSAST Troubleshooting & FAQ
•
Downloadable Documentation (CxSAST)
Translations
•
Test
Checkmarx Knowledge Center
CxSAST (REST) API - Projects
Get Project Details by Id - GET /projects/{id}
Summarize
Get Project Details by Id - GET /projects/{id}
David P (Deactivated)
Owned by
David P (Deactivated)
Last updated:
Jun 30, 2019
1 min read
Loading data...
This section includes REST APIs for working with projects.
Contents
Get Project Details by Id - GET /projects/{id} (v8.6.0 to v8.7.0)
Get Project Details by Id - GET /projects/{id} (v8.8.0 and up)
Read more:
CxSAST (REST) API - Swagger Examples
{"serverDuration": 17, "requestCorrelationId": "dbee710d7dcd40d1bfbd667817a1d94f"}