Introduction

Option 1: Check Scan Status for REST API-Triggered Scans

1. Trigger a scan using the Project Scan API. The API response returns a task ID.
2. Use the task ID to request the scan status. For example:

   curl -X GET "http://<HOSTNAME>:<PORT_NUMBER>/codeinsight/api/project/scanStatus/<TASK_ID>" \
   -H "accept: application/json" \
   -H "Authorization: Bearer <JWT>"

3. Review the response to determine the scan status.

Option 2: Check Scan Status for PlugIn-Triggered Scans

1. Trigger a scan from a remote scan agent plugin
2. Use the Jobs REST API to query recently completed scan jobs. For example:

   curl -X GET "http://<HOSTNAME>:<PORT_NUMBER>/codeinsight/api/jobs?jobType=Project%20Scan&status=Completed&projectId=<PROJ_ID>&triggeredBy=<USER>&jobsHistoryInDays=1&limit=1" \
   -H "accept: application/json" \
   -H "Authorization: Bearer <JWT>"

3. Review the response. If a job is returned, the scan is complete.
4. If the project was scanned more than once recently, check other statuses:
   • Waiting on Update
   • Scheduled
   • Active
5. If no jobs appear for any of these statuses, the scan has finished.

After completing these steps, you’ll be able to determine whether a scan is still running, queued, or completed.

• Get Scan Status
• Get jobs details based on filters