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

Create Folder

Request

Creates a folder for the given name and returns folderId with success message.

Security
bearerAuth
Bodyapplication/jsonrequired

To create a folder, folderName is required and parentFolderId is optional.

namestring[ 1 .. 255 ] charactersrequired

name

Example: "SCA"
parentFolderIdinteger(int32)>= 1

parentFolderId

Example: 1
curl -i -X POST \
  https://codeinsightapi.redocly.app/_mock/swagger/folders \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "SCA",
    "parentFolderId": 1
  }'

Responses

Created

Get Folder By Id

Request

Get existing folder by folderId

Security
bearerAuth
Path
folderIdinteger(int32)>= 1required
curl -i -X GET \
  'https://codeinsightapi.redocly.app/_mock/swagger/folders/{folderId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Update folder details

Request

Update folder details for the given folderId.

Security
bearerAuth
Path
folderIdinteger(int32)>= 1required
Bodyapplication/jsonrequired

Update details of a folder.

namestring[ 1 .. 255 ] charactersrequired

name

Example: "SCA"
parentFolderIdinteger(int32)>= 1

parentFolderId

Example: 1
curl -i -X PUT \
  'https://codeinsightapi.redocly.app/_mock/swagger/folders/{folderId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "SCA",
    "parentFolderId": 1
  }'

Responses

OK

Delete a folder

Request

Deleting a folder will delete all subfolders, contained projects will be associated wih the parent folder(Projects(0)).

Security
bearerAuth
Path
folderIdinteger(int64)>= 1required

ID of the folder

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

Responses

OK

Get folders based on the name provided

Request

Return folders based on the name provided

Security
bearerAuth
Query
folderNamestring

Search happens based on the name given

offsetinteger(int64)>= 1

Index of the page to start with

Default 1
limitinteger(int64)>= 1

Number of records to fetch

Default 25
curl -i -X GET \
  'https://codeinsightapi.redocly.app/_mock/swagger/folders/search?folderName=string&offset=1&limit=25' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

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