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

Get details of a file by Id

Request

Get file details of a given fileId. If the remote flag is true, it'll fetch the corresponding remote file info, otherwise by default the flag is false and scanner file information will be shown.

Security
bearerAuth
Path
fileIdinteger(int64)>= 1required

ID of the File

Example: 1
Query
isRemoteboolean

if true, fetch results of corresponding remote file

Default false
curl -i -X GET \
  'https://codeinsightapi.redocly.app/_mock/swagger/files/1?isRemote=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Mark file reviewed/unreviewed

Request

For the given fileId mark as reviewed/unreviewed. Only the Analyst has the permission to do this operation.

Security
bearerAuth
Path
fileIdinteger(int64)>= 1required

ID of the File

Example: 1
Query
isRemoteboolean

if true, fetch results of corresponding remote file

Default false
markAsReviewedboolean

if true, mark file as reviewed

Default false
curl -i -X PUT \
  'https://codeinsightapi.redocly.app/_mock/swagger/files/1/review?isRemote=false&markAsReviewed=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

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

Scan API

Operations

User API

Operations

vulnerability

Operations