Code Insight REST API Documentation (v1)

Download OpenAPI specification:Download

The Code Insight REST APIs provide a standard 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. The token must be included in the HTTP header as follows:

Authorization: Bearer JWT_TOKEN

Replace "JWT_TOKEN" with your authorization token. The word "Bearer" must precede the actual JWT token value.

CodebaseFolder

Mark Folder as Reviewed/Unreviewed

Use this API to mark all files in a given codebase folder (identified by its folderId) as reviewed or not reviewed. (All files within the folder will be marked the same.) If a corresponding remote folder exists, you can choose to have its files also marked with the same status.

To obtain the folderId for a given codebase folder, use the Get ID of File or Folder API (/projects/{projectId}/files).

Request

path Parameters

folderId

required

integer <int32>

ID of the folder

Example: 1

query Parameters

isRemote	boolean Default: false If true, fetch results of corresponding remote folder.
markAsReviewed	boolean Default: false If true, mark files inside the folder as reviewed.

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/codebasefolder/{folderId}/review

➔ Next to CodebaseFolder