Get All Engine Server Details - GET /sast/engineServers (v8.5.0)

Get details of all engine servers. The retrieved engine server id (id) can be used to get details of a specific engine server using GET /sast/engineServers/{id}.

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

/cxrestapi/sast/engineServers

Method:

GET

Media Type (header):

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

Parameters

None

Success Response:

Code: 200 OK

Error Response:

Code: 400 Bad Request

Sample Response:

[
  {
    "id": 1,
    "name": "Localhost",
    "uri": "http://Localhost/CxSourceAnalyzerEngineWCF/CxEngineWebServices.svc",
    "minLoc": 0,
    "maxLoc": 999999999,
    "isAlive": true,
    "maxScans": 3,
    "isBlocked": false,
    "cxVersion": "8.5.0.1938"
  }
]

Notes:

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