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

Remove child Projects from parent project

Request

Remove child project from parent project

Security
bearerAuth
Path
projectIdinteger(int64)>= 1required

Id of Parent Project

Example: 1
Query
childProjectIdsArray of integers(int32)required

Id of Child Projects

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

Responses

OK

Users

Request

Get Project Users with respect to Role

Security
bearerAuth
Path
projectIdinteger(int64)>= 1required

ID of the Project

Example: 1
Query
roleIdstringANALYST|REVIEWER|OBSERVER|PROJECT_ADMINrequired
Default "ANALYST"
Enum"ANALYST""REVIEWER""OBSERVER""PROJECT_ADMIN"
curl -i -X GET \
  'https://codeinsightapi.redocly.app/_mock/swagger/projects/1/users?roleId=ANALYST' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Assign Role

Request

Assign a Users to a specific Project Role.
Here "ownerId refers to the "contactId of the project.

Security
bearerAuth
Path
projectIdinteger(int64)>= 1required

ID of the Project

Example: 1
Bodyapplication/jsonrequired

Add a Users to a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER

ownerIdstring

ownerId

Example: "admin"
securityContactIdstring

securityContactId

Example: "admin"
developerContactIdstring

developerContactId

Example: "admin"
legalContactIdstring

legalContactId

Example: "admin"
userRolesobject(usersRole)
legalContactstringwrite-only
curl -i -X POST \
  https://codeinsightapi.redocly.app/_mock/swagger/projects/1/users \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ownerId": "admin",
    "securityContactId": "admin",
    "developerContactId": "admin",
    "legalContactId": "admin",
    "userRoles": {
      "roleId": "ANALYST",
      "users": [
        "string"
      ]
    },
    "legalContact": "string"
  }'

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