Internal API for fetching custom email templates and images from core server
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
Languages
Servers
Mock server
https://codeinsightapi.redocly.app/_mock/swagger
Code Insight REST API Server
https://codeinsightapi.redocly.app/codeinsight/api
Request
Imports project data for a given projectId. Only Project Owner and Analyst can Import Project Data into a private project.
Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL
When calling this API from a REST client, you need to run either of the curl commands.
Save the required attributes in a json or a text file for project import and provide that file in the command. If you are using text file, don't give .txt extension.
curl -H "Authorization:Bearer %jwt%" -F importFile=@"fileToImport.zip" -F projectImportModel=@"JsonFile.json Or textFile;type=application/json" http://localhost:8888/codeinsight/api/projects/%projectId%/importOr else, instead of providing file, you can directly define the attributes for projectImportModel inside curly braces.
Provide 'FileMatchingCriteria' either of the below values:
COMPLETE_FILEPATH|PARTIAL_FILEPATH|FILENAME|MD5|MD5_AND_FILENAME|MD5_AND_COMPLETE_FILEPATH|MD5_AND_PARTIAL_FILEPATH
Security
bearerAuth
- Mock serverhttps://codeinsightapi.redocly.app/_mock/swagger/projects/{projectId}/import
- Code Insight REST API Serverhttps://codeinsightapi.redocly.app/codeinsight/api/projects/{projectId}/import
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://codeinsightapi.redocly.app/_mock/swagger/projects/{projectId}/import' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: multipart/form-data' \
-F 'Project Import Model[createEmptyInventory]=false' \
-F 'Project Import Model[overwriteInventoryNotes]=true' \
-F 'Project Import Model[addFilesToInventory]=true' \
-F 'Project Import Model[inventoryFileMatchingCriteria]=COMPLETE_FILEPATH' \
-F 'Project Import Model[inventoryDirectoryDepth]=1' \
-F 'Project Import Model[markFilesAsReviewed]=true' \
-F 'Project Import Model[reviewFileMatchingCriteria]=MD5_AND_COMPLETE_FILEPATH' \
-F 'Project Import Model[reviewDirectoryDepth]=1' \
-F 'Project Import Model[resetInventoryUsage]=true'Request
Imports Sbom for a given projectId. Only Project Owner and Analyst can Import Project Sbom into a private project.
Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL. When calling this API from a REST client, you need to run either of the curl commands.
curl -H "Authorization:Bearer %jwt%" -F sbomFile=@"fileToImport.json;type=application/json" http://localhost:8888/codeinsight/api/projects/%projectId%/importSbomSecurity
bearerAuth
- Mock serverhttps://codeinsightapi.redocly.app/_mock/swagger/projects/{projectId}/importSbom
- Code Insight REST API Serverhttps://codeinsightapi.redocly.app/codeinsight/api/projects/{projectId}/importSbom
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://codeinsightapi.redocly.app/_mock/swagger/projects/{projectId}/importSbom' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: multipart/form-data' \
-F 'sbomFile[type]=string' \
-F 'sbomFile[parameters][property1]=string' \
-F 'sbomFile[parameters][property2]=string' \
-F 'sbomFile[fileName]=string' \
-F 'sbomFile[creationDate]=2019-08-24T14:15:22Z' \
-F 'sbomFile[modificationDate]=2019-08-24T14:15:22Z' \
-F 'sbomFile[readDate]=2019-08-24T14:15:22Z' \
-F 'sbomFile[size]=0' \
-F 'sbomFile[name]=string' \
-F 'Delete SBOM bucket=string'Request
This API is deprecated please refer to /projects/{projectId}/reports/{reportId}/generate to Generate a report.
Refer /projects/{projectId}/reports/{reportId}/download to Download a report.
Generates Reports (PROJECT, AUDIT, NOTICES, CUSTOM_REPORT) for a given projectId. For CUSTOM_REPORT provide the name of the report. All project users including Observer, Reviewer and Analyst can generate reports for private projects.
Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL.
When calling this API from a REST client, you need to redirect output to a zip file as follows
curl -X GET "http://HOST:PORT/codeinsight/api/project/generateReport?reportType=REPORT_TYPE&projectId=PROJECT_ID" -H "accept: application/octet-stream" -H "Authorization: Bearer JWT_TOKEN" > report.zipSecurity
bearerAuth
- Mock serverhttps://codeinsightapi.redocly.app/_mock/swagger/project/generateReport
- Code Insight REST API Serverhttps://codeinsightapi.redocly.app/codeinsight/api/project/generateReport
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://codeinsightapi.redocly.app/_mock/swagger/project/generateReport?projectId=1&reportType=PROJECT&otherProjectId=1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'