Get Engine Details - GET /sast/engineServers/{id} (v8.6.0 and up)

Get details of a specific engine server by Id. In order to get details of a specific engine server you should first retrieve the engine server Id (id). To retrieve the engine server Id (id) use GET /sast/engineServers.

Usage

1. GET /sast/engineServers and get details of all engine servers
2. GET /sast/engineServers/{id} and get details of a specific engine server

URL

http://localhost/cxrestapi/sast/engineServers/{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 engine server

Curl Sample:

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer <access token> 'http://localhost/cxrestapi/sast/engineServers/2'

Sample Response:

{
   "id": 1,
   "name": "Localhost",
   "uri":
 "http://Localhost/CxSourceAnalyzerEngineWCF/CxEngineWebServices.svc",
   "minLoc": 0,
   "maxLoc": 999999999,
   "maxScans": 2,
   "cxVersion": "8.6.0.1921",
   "status": {
     "id": 4,
     "value": "Idle"
   },
   "link": {
     "rel": "self",
     "uri": "/sast/engineServers/1"
   }
 }

Success Response:

Code: 200 OK

Error Response:

Code: 404 Not Found

Notes:

Retrieves details of a specific engine server by Id. If the request fails, it returns an error response. Must be a valid (registered) engine server in order to get details. Possible statuses are: 0=Offline, 1=Blocked, 2=Scanning and Blocked, 3=Scanning or 4=Idle.