Skip to content

Code Insight REST API Documentation (v1)

The Code Insight REST APIs provide a standardized interface for interacting with the application.

An authorization JWT token must be included in the HTTP Authorization header using the Bearer schema. The token can be obtained from the Code Insight Web UI under the Preferences menu. To set the token, click the Authorize button below on the right, enter the JWT token in the Value field, then click Authorize and close the dialog. Once authorized, the token will be automatically included in the HTTP Authorization header for all API requests made through the Swagger UI.

Note: If accessing the REST APIs through external tools such as curl or Postman, include the token manually in the HTTP header using the following format: Authorization: Bearer JWT_TOKEN. "Bearer" must precede the actual JWT token value.

Download OpenAPI description
swagger.json
swagger.yaml
Languages
Servers
Mock server
https://codeinsightapi.redocly.app/_mock/swagger
Code Insight REST API Server
https://codeinsightapi.redocly.app/codeinsight/api

Email Templates

Internal API for fetching custom email templates and images from core server

Operations

CodebaseFolder

Operations

Deprecated APIs

Operations

Component

Operations

Files

Operations

Folder

Operations

Project API

Operations

Inventory API

Operations

inventoryWorkflow

Operations

Jobs

Operations

ldap

Operations

license

Operations

sourceCodeManagement

Operations

Reports

Operations

Rules

Operations

Scan profiles

Operations

Task

Operations

Assign Alm Issues

Request

Assign Alm Issues to task

Security
bearerAuth
Path
taskIdinteger(int64)>= 1required

ID of the task to be updated

Example: 1
Bodyapplication/jsonrequired

Map alm Issues to workflow task

idsArray of integers(int32)required

almIssueId

curl -i -X POST \
  https://codeinsightapi.redocly.app/_mock/swagger/tasks/1/issues \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ids": [
      0
    ]
  }'

Responses

OK

Close Task

Request

Close Task

Security
bearerAuth
Path
taskIdinteger(int64)>= 1required

ID of the task to be closed

Example: 1
Query
resolutionstringCLOSED|APPROVED|REJECTEDrequired
Default "CLOSED"
Enum"CLOSED""APPROVED""REJECTED"
curl -i -X PUT \
  'https://codeinsightapi.redocly.app/_mock/swagger/tasks/1/close?resolution=CLOSED' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Create Task

Request

Create Task

Security
bearerAuth
Query
inventoryIdinteger(int64)>= 1required

ID of the inventory to be used to create the task

Example: inventoryId=1
Bodyapplication/jsonrequired

Create new workflow task priority :"LOW, MEDIUM, HIGH" type : "MISCELLANEOUS, MANUAL_INVENTORY_REVIEW, REMEDIATE_INVENTORY"

ownerstring

owner

Example: "admin"
summarystring

summary

Example: "Summary for the task"
prioritystring

priority

Enum"LOW""MEDIUM""HIGH"
Example: "MEDIUM"
typestring

type

Enum"MISCELLANEOUS""MANUAL_INVENTORY_REVIEW""REMEDIATE_INVENTORY"
Example: "MISCELLANEOUS"
detailsstring

details

Example: "Details of the task"
curl -i -X POST \
  'https://codeinsightapi.redocly.app/_mock/swagger/tasks?inventoryId=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "owner": "admin",
    "summary": "Summary for the task",
    "priority": "MEDIUM",
    "type": "MISCELLANEOUS",
    "details": "Details of the task"
  }'

Responses

Created

Get Task

Request

Get Task

Security
bearerAuth
Path
taskIdinteger(int64)>= 1required

ID of the task to be fetched

Example: 1
curl -i -X GET \
  https://codeinsightapi.redocly.app/_mock/swagger/tasks/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Update Task

Request

Update Task

Security
bearerAuth
Path
taskIdinteger(int64)>= 1required

ID of the task to be updated

Example: 1
Bodyapplication/jsonrequired

Update existing workflow task priority :"LOW, MEDIUM, HIGH"

summarystring

summary

Example: "Summary for the task"
prioritystring

priority

Enum"LOW""MEDIUM""HIGH"
Example: "MEDIUM"
detailsstring

details

Example: "Details of the task"
curl -i -X PUT \
  https://codeinsightapi.redocly.app/_mock/swagger/tasks/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "summary": "Summary for the task",
    "priority": "MEDIUM",
    "details": "Details of the task"
  }'

Responses

OK

Reassign Task

Request

Reassign Task

Security
bearerAuth
Path
taskIdinteger(int64)>= 1required

ID of the task to be reassigned

Example: 1
Query
ownerIdstringrequired

ID / Name of the owner to whom the task needs to be reassigned (Example: admin)

curl -i -X PUT \
  'https://codeinsightapi.redocly.app/_mock/swagger/tasks/1/reassign?ownerId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Get Tasks based on the search Terms

Request

Return Tasks associated with the search term

Security
bearerAuth
Query
projectIdinteger(int64)>= 1

ID of the Project to be used in search

Example: projectId=1
inventoryIdinteger(int64)>= 1

ID of the inventory to be used in search

Example: inventoryId=1
offsetinteger(int64)>= 1

Index of the page to start with

Default 1
limitinteger(int64)>= 1

Number Of Records to fetch

Default 25
statusstring

Status of the Task to be used in search

Default "ALL"
Enum"OPEN""CLOSED""ALL"
typestringMISCELLANEOUS|MANUAL_INVENTORY_REVIEW|REMEDIA...

Type of the Task to be used in search

Default "ALL"
Enum"MISCELLANEOUS""MANUAL_INVENTORY_REVIEW""REMEDIATE_INVENTORY""ALL"
prioritystring

Priority of the Task to be used in search

Default "ALL"
Enum"LOW""MEDIUM""HIGH""ALL"
curl -i -X GET \
  'https://codeinsightapi.redocly.app/_mock/swagger/tasks/search?projectId=1&inventoryId=1&offset=1&limit=25&status=OPEN&type=MISCELLANEOUS&priority=LOW' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Scan API

Operations

User API

Operations

vulnerability

Operations