Start an analysis

The start_analysis request initiates an analysis on a device, group, or matrix.

The input will be the active session ID and the name of the device, group, or matrix. The output will include a status and message which indicates success or failure.

Resource Name: /fa/server/analysis/start

Request Method: POST

Request URL Parameters:

Element

Type

Description
sessionMandatory

String

Session ID returned in login request.
entityMandatory

String

The display name of the device, group, or matrix.
entityTypeMandatory

String

One of the following:

    device
    group
    matrix
Response:

Element

Type

Description
status

String

One of the following:

  • true. Indicates the request succeeded.
  • false. Indicates the request failed.
message

String

An message which indicates success or a reason for failure.

Request example

curl -k " -H "Accept:application/json" 'https://10.20.1.242/fa/server/analysis/start?session=d42b992578b5f3ef07358a29797bd442&entityType= device&entity=Humus'

Response example

{   "status": true,   "message": "success"}