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

Get Project Information

Request

Get Project Information By Id

Security
bearerAuth
Path
projectIdinteger(int64)required

ID of the Project

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

Responses

OK

Update Project

Request

Updates a project, custom field values for the given projectId.
Here "owner" field refers to the "contact" of the project.

Security
bearerAuth
Path
projectIdinteger(int64)>= 1required

ID of the Project

Example: 1
Bodyapplication/jsonrequired

Updates a project, autoPublish is required when markAssociatedFilesAsReviewed and doNotPublishInventoryUnknownLicense is part of a request.

namestring

name

Example: "eportal"
descriptionstring

description

Example: "description"
folderNamestring

folderName

Example: "Projects"
policyProfileNamestring

policyProfileName

Example: "Default License Policy Profile"
scanProfileNamestring

scanProfileName

Example: "Basic Scan Profile (Without CL)"
autoPublishboolean

autoPublish

Example: true
markAssociatedFilesAsReviewedboolean

markAssociatedFilesAsReviewed

Example: true
ownerstring

owner

Example: "admin"
riskstringHIGH|MEDIUM|LOW

risk

Enum"HIGH""MEDIUM""LOW"
Example: "HIGH | default: MEDIUM"
privateProjectboolean

privateProject

Example: false
deleteEmptyInventoryboolean

deleteEmptyInventory

Example: false
doNotPublishInventoryUnknownLicenseboolean

doNotPublishInventoryUnknownLicense

Example: true
folderIdinteger(int32)
Example: 1
expandJarArchivesboolean

expandJarArchives

Example: false
customFieldsArray of objects(CustomFieldModel)

customFields

curl -i -X PUT \
  https://codeinsightapi.redocly.app/_mock/swagger/projects/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "eportal",
    "description": "description",
    "folderName": "Projects",
    "policyProfileName": "Default License Policy Profile",
    "scanProfileName": "Basic Scan Profile (Without CL)",
    "autoPublish": true,
    "markAssociatedFilesAsReviewed": true,
    "owner": "admin",
    "risk": "HIGH | default: MEDIUM",
    "privateProject": false,
    "deleteEmptyInventory": false,
    "doNotPublishInventoryUnknownLicense": true,
    "folderId": 1,
    "expandJarArchives": false,
    "customFields": [
      {
        "id": 1,
        "value": "Value for custom field"
      }
    ]
  }'

Responses

OK

Delete a project, deletion operation will be added to queue. To get status of project deletion use jobs/{jobId} API

Request

Deleting a project will delete all project inventory, custom field values, corresponding notes and all code base files permanently from the server.

Security
bearerAuth
Path
projectIdinteger(int64)>= 1required

ID of the Project

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

Responses

Accepted

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