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

For the given folderId mark as reviewed/unreviewed. Only the Analyst has the permission to do this operation.

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

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/codebasefolder/{folderId}/review