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

Update Project Contact

Request

Updates project contact for the given projectId.

Security
bearerAuth
Path
projectIdinteger(int64)>= 1required

ID of the Project

Example: 1
Bodyapplication/jsonrequired

Updates a project contact

contactstringrequired

contact

Example: "admin"
curl -i -X PUT \
  https://codeinsightapi.redocly.app/_mock/swagger/projects/1/contact \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contact": "admin"
  }'

Responses

OK

Get project inventories for the given scan-agent or scan-server alias

Request

Returns all inventories of the project associated with the given scan-agent or scan-server alias

Security
bearerAuth
Path
projectIdinteger(int64)>= 1required

ID of the Project

Example: 1
aliasstringrequired

Alias of scan-server or scan-agent (Example: generic-plugin-test)

Query
limitinteger(int64)>= 1

Page Size. Number Of Records to fetch per page

Default 25
offsetinteger(int64)>= 1

Page Number. Index of the page to start with(starts from 1)

Default 1
curl -i -X GET \
  'https://codeinsightapi.redocly.app/_mock/swagger/projects/1/inventories/{alias}?limit=25&offset=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Get Inventory Summary of the project

Request

Get Project level inventory summary

Security
bearerAuth
Path
projectIdinteger(int64)>= 1required

ID of the Project

Example: 1
Query
vulnerabilitySummaryboolean

If false , hide vulnerabilty summary details

Default false
cvssVersionstring

CVSS : This field is required only if vulnerabilitySummary is set to true

Enum"V2""V3""ANY"
publishedstring

If published, then only published inventory items are returned; if unpublished, then only not-published inventory items are returned; if all, then return all inventories

Default "PUBLISHED"
Enum"PUBLISHED""UNPUBLISHED""ALL"
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/projects/1/inventorySummary?vulnerabilitySummary=false&cvssVersion=V2&published=PUBLISHED&offset=1&limit=25' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

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