Get SAST Scan Details by Scan Id - GET /sast/scans/{id} (v8.6.0 to v8.7.0)

Get details of a specific SAST scan. Scan details can only be retrieved once a scan has been performed and the scan Id (id) is known. To create a new scan use POST /sast/scans.

Usage:

1. POST /sast/scan and create a new scan
2. GET /sast/scans/{id} and get details of a specific scan

URL

/cxrestapi/sast/scans/{id}

Method:

GET

Media Type (header):

Authorization: Bearer <access token value>
Accept: application/json;v=1.0

Parameters

Required:

id=[integer] – Unique Id of the scan

Success Response:

Code: 200 OK

Error Response:

Code: 400 Bad Request

Sample Response:

{
   "id": 1000003,
   "project": {
     "id": 2,
     "name": null,
     "link": {
       "rel": "project",
       "uri": "/projects/2"
     }
   },
   "status": {
     "id": 7,
     "name": "Finished",
     "details": {
       "stage": "Scan completed",
       "step": ""
     }
   }
 }

Notes:

Retrieves details of a specific SAST scan. Must be a valid SAST scan in order to retrieve scan details. If the request fails, it returns an error response. Must be a valid SAST scan in order to retrieve scan details.