Start an analysis

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

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

Resource Name:

/api/v1/analysis/start

Request Method: POST

Request URL Parameters:

Element

Type

Description
session Mandatory

String

Session ID returned in login request.
entity Mandatory

String

The display name of the device or group.
entityType Mandatory

String

One of the following:

    device default
    group
riskProfile string Risk profile to use in analysis. If left empty the Standard profile is used.
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 -X POST “https://localhost/afa/api/v1/analysis/start?entityType=device&entity=Humus&riskProfile=testAPI.xml" -H “accept: */*” –cookie “PHPSESSID=d42b992578b5f3ef07358a29797bd442”

Response example 

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