Corgea API Endpoints
Welcome to the Corgea CLI API Documentation. This API enables you to interact with the Corgea platform programmatically, allowing for various operations such as verifying tokens, uploading scans, managing issues, and more. Below you will find a comprehensive guide to all available endpoints, including the necessary parameters, request bodies, and responses.
All endpoints referenced in this documentation have the following base URL:
The Corgea CLI API uses token-based authentication. Ensure you include the token in your requests as required by specific endpoints. Unauthorized requests will result in a 401 status code.
GET /cli/verify/{token}
This endpoint checks if the provided token is valid and returns the status of the verification.POST /cli/scan-upload
This endpoint allows you to upload a JSON report of a security scan for a specific run, identified by a run ID.POST /cli/git-config-upload
This endpoint allows you to upload git configuration data for a specific run, identified by a run ID.POST /cli/code-upload
This endpoint allows you to upload code files for security analysis, for a specific run, identified by a run ID.POST /cli/ci-data-upload
This endpoint allows you to upload CI-related data for a specific run, identified by a run ID.GET /cli/issues
This endpoint retrieves a list of all security issues related to a specified project.GET /cli/issues-tree
This endpoint retrieves a hierarchical representation of issues, grouped by file paths.GET /cli/issue/{issue_id}
This endpoint retrieves detailed information for a specific issue, including its status and any available fixes.The API uses standard HTTP status codes to indicate the success or failure of an API request. Common status codes include:
200 OK
: The request was successful.400 Bad Request
: The request was invalid or cannot be otherwise served.401 Unauthorized
: Authentication failed or user does not have permissions for the requested operation.404 Not Found
: The requested resource could not be found.To get started with the Corgea CLI API:
/cli/verify/{token}
endpoint./cli/scan-upload
endpoint to upload your scan data.For detailed information on each endpoint, refer to the specific sections in this documentation.
We hope this documentation helps you effectively utilize the Corgea CLI API. If you have any questions or need further assistance, please contact our support team.
Corgea API Endpoints
Welcome to the Corgea CLI API Documentation. This API enables you to interact with the Corgea platform programmatically, allowing for various operations such as verifying tokens, uploading scans, managing issues, and more. Below you will find a comprehensive guide to all available endpoints, including the necessary parameters, request bodies, and responses.
All endpoints referenced in this documentation have the following base URL:
The Corgea CLI API uses token-based authentication. Ensure you include the token in your requests as required by specific endpoints. Unauthorized requests will result in a 401 status code.
GET /cli/verify/{token}
This endpoint checks if the provided token is valid and returns the status of the verification.POST /cli/scan-upload
This endpoint allows you to upload a JSON report of a security scan for a specific run, identified by a run ID.POST /cli/git-config-upload
This endpoint allows you to upload git configuration data for a specific run, identified by a run ID.POST /cli/code-upload
This endpoint allows you to upload code files for security analysis, for a specific run, identified by a run ID.POST /cli/ci-data-upload
This endpoint allows you to upload CI-related data for a specific run, identified by a run ID.GET /cli/issues
This endpoint retrieves a list of all security issues related to a specified project.GET /cli/issues-tree
This endpoint retrieves a hierarchical representation of issues, grouped by file paths.GET /cli/issue/{issue_id}
This endpoint retrieves detailed information for a specific issue, including its status and any available fixes.The API uses standard HTTP status codes to indicate the success or failure of an API request. Common status codes include:
200 OK
: The request was successful.400 Bad Request
: The request was invalid or cannot be otherwise served.401 Unauthorized
: Authentication failed or user does not have permissions for the requested operation.404 Not Found
: The requested resource could not be found.To get started with the Corgea CLI API:
/cli/verify/{token}
endpoint./cli/scan-upload
endpoint to upload your scan data.For detailed information on each endpoint, refer to the specific sections in this documentation.
We hope this documentation helps you effectively utilize the Corgea CLI API. If you have any questions or need further assistance, please contact our support team.