Code Insight REST API Documentation (v1)

Download OpenAPI specification:Download

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.

CodebaseFolder

Mark folder as reviewed/unreviewed

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

SecuritybearerAuth
Request
path Parameters
folderId
required
integer <int64> >= 1

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

Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/codebasefolder/{folderId}/review