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

Get Reports

Request

Get existing reports

Security
bearerAuth
Query
reportIdinteger(int64)>= 1

ID of the Report to be used in search

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

Index of the page to start with

Default 1
limitinteger(int64)>= 1

Number Of Records to fetch

Default 25
namestring

Name of the Report to be used in search

pathstring

Path of the Script to be used in search

enabledboolean

Enabled status of the Report to be used in search

defaultboolean

Default status of the Report to be used in search

orderinteger(int64)

Order of the Report to be used in search (Example: 1)

curl -i -X GET \
  'https://codeinsightapi.redocly.app/_mock/swagger/reports?reportId=1&offset=1&limit=25&name=string&path=string&enabled=true&default=true&order=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Update Report

Request

Update existing report

Security
bearerAuth
Bodyapplication/jsonrequired

Update existing report.

idinteger(int32)

id

Example: 1
namestringrequired

name

Example: "Name of the report"
pathstringrequired

path

Example: "Path of the report"
enabledboolean

enabled

Example: true
orderinteger(int32)>= 1required

order

Example: 4
enableProjectPickerboolean

enableProjectPicker

Example: false
reportOptionsArray of objects(ReportCriteriaModel)
curl -i -X PUT \
  https://codeinsightapi.redocly.app/_mock/swagger/reports \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 1,
    "name": "Name of the report",
    "path": "Path of the report",
    "enabled": true,
    "order": 4,
    "enableProjectPicker": false,
    "reportOptions": [
      {
        "name": "Name of the Report Parameter",
        "label": "Display Name of the Report Parameter",
        "description": "Description of the Report Parameter",
        "type": "Type of the Report Parameter",
        "defaultValue": "Default value of the Report Parameter",
        "required": false,
        "order": 4
      }
    ]
  }'

Responses

OK

Create Report

Request

Add new report. All the report options, if given will have datatype as String/text.

Security
bearerAuth
Bodyapplication/jsonrequired

Add new report.

namestringrequired

name

Example: "Name of the report"
pathstringrequired

path

Example: "Path of the report"
enabledboolean

enabled

Example: true
orderinteger(int32)>= 1required

order

Example: 4
enableProjectPickerboolean

enableProjectPicker

Example: false
reportOptionsArray of objects(ReportCriteriaModel)
curl -i -X POST \
  https://codeinsightapi.redocly.app/_mock/swagger/reports \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Name of the report",
    "path": "Path of the report",
    "enabled": true,
    "order": 4,
    "enableProjectPicker": false,
    "reportOptions": [
      {
        "name": "Name of the Report Parameter",
        "label": "Display Name of the Report Parameter",
        "description": "Description of the Report Parameter",
        "type": "Type of the Report Parameter",
        "defaultValue": "Default value of the Report Parameter",
        "required": false,
        "order": 4
      }
    ]
  }'

Responses

Created

Get Report By Id

Request

Get existing report by reportId

Security
bearerAuth
Path
reportIdinteger(int32)required
curl -i -X GET \
  'https://codeinsightapi.redocly.app/_mock/swagger/reports/{reportId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Delete Report by Id

Request

Delete the report by report id

Security
bearerAuth
Path
reportIdinteger(int32)required
Default 0
curl -i -X DELETE \
  'https://codeinsightapi.redocly.app/_mock/swagger/reports/{reportId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Rules

Operations

Scan profiles

Operations

Task

Operations

Scan API

Operations

User API

Operations

vulnerability

Operations