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

Add Files and/or Folders to Inventory

Request

Add files and/or folders to inventory item and returns the response message

Security
bearerAuth
Path
inventoryIdinteger(int64)required

ID of the Inventory

Example: 1
Bodyapplication/jsonrequired

To Add files and folders to the inventory provide file and folder paths.

filePathsArray of strings

filePaths

folderPathsArray of strings

folderPaths

markAssociatedFilesAsReviewedboolean

markAssociatedFilesAsReviewed

Example: false
curl -i -X PUT \
  https://codeinsightapi.redocly.app/_mock/swagger/inventories/1/files \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filePaths": [
      "string"
    ],
    "folderPaths": [
      "string"
    ],
    "markAssociatedFilesAsReviewed": false
  }'

Responses

OK

Bodyapplication/json
string
Response
application/json
"string"

Create Inventory

Request

Create an inventory. Name and Inventory type is a mandatory field.

Note: Value for rememberLicense can be GLOBAL or INVENTORY (default).

  • GLOBAL: Saves and applies the component version and license mapping to the current inventory and all future inventories across projects.
  • INVENTORY: Updates only the current inventory. Future inventories will use the original license mapping.
Security
bearerAuth
Bodyapplication/jsonrequired
projectIdinteger(int32)>= 1required

projectId

Example: 1
inventoryModelobject(CreateInventoryModel)

inventoryModel

curl -i -X POST \
  https://codeinsightapi.redocly.app/_mock/swagger/inventories \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "projectId": 1,
    "inventoryModel": {
      "name": "maven-artifact 3.6.1 (Apache-2.0)",
      "description": "Sources: scm:git:https://git-wip-us.apache.org/repos/asf/maven.git",
      "url": "https://repo1.maven.org/maven2/org/apache/maven/maven-artifact",
      "priority": "P1 | P2 | P3 | P4",
      "disclosed": "YES | NO",
      "distribution": "UNKNOWN | INTERNAL | EXTERNAL | HOSTED_ANY | HOSTED_INTERNAL | HOSTED_EXTERNAL",
      "partOfProduct": "UNKNOWN | YES | NO",
      "linking": "UNKNOWN | NOT_LINKED | STATIC | DYNAMIC",
      "modified": "UNKNOWN | YES | NO",
      "encryption": "UNKNOWN | YES | NO",
      "auditorReviewNotes": "string",
      "noticeText": "string",
      "usageGuidance": "string",
      "remediationNotes": "string",
      "confidenceLevel": "HIGH | MEDIUM | LOW default: HIGH",
      "inventoryType": "COMPONENT | LICENSE | WORK_IN_PROGRESS",
      "component": {
        "id": "58316",
        "versionId": "3704669",
        "licenseId": "158"
      },
      "licenseId": "158",
      "rememberLicense": "GLOBAL | INVENTORY default: INVENTORY",
      "workflowURL": "SVM-123 | https://www.example.com | default: None",
      "invProvenanceId": 1,
      "customFields": [
        {
          "id": 1,
          "value": "Value for custom field"
        }
      ]
    }
  }'

Responses

Created

Get details of an inventory

Request

Get details of an inventory.

Security
bearerAuth
Path
inventoryIdinteger(int64)required

ID of the Inventory

Example: 1
Query
skipVulnerabilitiesboolean

If true , hide vulnerabilty details

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

Responses

OK

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