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

Get parents of an inventory

Request

Fetches the parents for a given inventoryId.

Security
bearerAuth
Path
inventoryIdinteger(int64)required

ID of the Inventory

Example: 1
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/inventories/1/parents?limit=25&offset=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
string
Response
application/json
"string"

Get All Inventories by Date

Request

Returns a list of inventories and relevant details within the given date and time. All users can view project inventories of public projects and users with permission can view the inventories of private project

Security
bearerAuth
Query
startTimestring

Start time for an inventory (Format: YYYY-MM-DD HH:MM:SS)

endTimestring

End time for an inventory (Format: YYYY-MM-DD HH:MM:SS)

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"
sizeinteger(int64)

Page Size. Number Of Records to fetch per page

Default 100
pageinteger(int64)

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

Default 1
curl -i -X GET \
  'https://codeinsightapi.redocly.app/_mock/swagger/inventories/searchByDate?startTime=string&endTime=string&published=PUBLISHED&size=100&page=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Get the inventories of file/folder ids

Request

Returns the inventories file and/or folder ids

Security
bearerAuth
Query
projectIdinteger(int64)>= 1required

ID of the Project

Example: projectId=1
fileIdsstring

Provide list of file ids

folderIdsstring

Provide list of folder ids

publishedboolean

If true, then only published inventory items are returned; if false, then only un-published inventory items are returned

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/inventories/search?projectId=1&fileIds=string&folderIds=string&published=true&limit=25&offset=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
object(Json)
Response
application/json
{}

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