Skip to content

project status

Request

Updates the status of a project. By default, a newly created project has the status "Not Started". After scanning begins, the status is automatically updated to "Analysis In Progress". Note: ProjectAction can be specified with below values:

  • Update Status Only: Only updates the status of the project, if project status is kept COMPLETED, it will lock the current project.
  • Lock Child Projects: Locks all child projects of the current project. (allowed only if project status is kept COMPLETED)
  • Unlock Child Projects: Unlocks all child projects of the current project. (allowed only if project status is not COMPLETED) Use projectAction to control the locking behavior in relation to the project's current status.
Security
bearerAuth
Path
projectIdinteger, (int64), >= 1required

ID of the Project

Example:1
Query
statusstringrequired
Default:"Not Started"
Enum:"Not Started""Analysis In Progress""Analysis Completed""Project Completed"
projectActionstringrequired
Default:"Update Status Only"
Enum:"Update Status Only""Lock Child Projects""Unlock Child Projects"
curl -i -X PUT \
  'https://codeinsightapi.redocly.app/_mock/swagger/projects/1/status?status=Not%20Started&projectAction=Update%20Status%20Only' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK