Scan Engine Operations

/AppSpiderEnterprise/rest/v1/Engine/GetEngines

Description

Retrieves the list of scan engines

Parameters

No parameters

Response Messages

Response Status CodeReasonDescription
200Response contains the list of scan engines

Response example:

{ "type": "object", "properties": { "Engines": { "type": "array", "properties": { "Id": { "type": "string", "required": true }, "Url": { "type": "string", "required": true, "maxLength": 512 }, "Login": { "type": "string", "required": true, "maxLength": 32 }, "Password": { "type": "string", "required": true, "maxLength": 32 }, "Notes": { "type": ["string", "null"] "required": true, "maxLength": 512 }, "IsBeingUpdated": { "type": "boolean", "required": true, }, "DoNotUpdate": { "type": "boolean", "required": true, }, "Type": { "type": "string", "required": true, }, "VirtualName": { "type": "string", "required": true, "maxLength": 50 } } }, "additionalProperties": false }, "IsSuccess": { "type": "boolean", "required": true }, "ErrorMessage": { "type": ["string", "null"], "required": true "Reason": { "type": ["string", "null"], "required": true } }, "additionalProperties": false }

Reference Guide

/Engine/GetEngines

/AppSpiderEnterprise/rest/v1/Engine/SaveEngine

Description

Creates or updates scan engine

Parameters

NameTypeRequiredDescription
idstringNif id not provided new engine will be created. if id provided engine update performed.
urlstringYScan engine URL. URL scheme should be {scheme}://{domain}/{path}/default.asmx
virtualNamestringYScan engine name
loginstringYScan engine username
passwordstringYScan engine password
notesstringNNotes
doNotUpdateboolNDo not update engine property

Response Messages

Response example:

{ "type": "object", "properties": { "IsSuccess": { "type": "boolean", "required": true }, "ErrorMessage": { "type": ["string", "null" ], "required": true }, "Reason": { "type": ["string", "null" ], } }, "additionalProperties": false }

Reference Guide

/Engine/SaveEngine

/AppSpiderEnterprise/rest/v1/Engine/DeleteEngine

Description

Deletes a scan engine(s)

Parameters

NameTypeRequiredDescription
idsguid[]YScan engine IDs

Response Messages

Response status codeReasonDescription
200Scan engine(s) removed
400InvalidJsonSchemaRequired parameters not provided

Response example:

{ "type": "object", "properties": { "IsSuccess": { "type": "boolean", "required": true }, "ErrorMessage": { "type": [ "string", "null" ], "required": true }, "Reason": { "type": [ "string", "null" ], "required": true } }, "additionalProperties": false }

Reference Guide

/Engine/DeleteEngine