Scan Engine Operations

get /AppSpiderEnterprise/rest/v1/Engine/GetEngines

Description

Retrieves the list of scan engines

Parameters

No parameters

Response Messages

Response Status Code	Reason	Description
200		Response 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 post /AppSpiderEnterprise/rest/v1/Engine/SaveEngine

Description

Creates or updates scan engine

Parameters

Name	Type	Required	Description
id	string	N	if id not provided new engine will be created. if id provided engine update performed.
url	string	Y	Scan engine URL. URL scheme should be `{scheme}://{domain}/{path}/default.asmx`
virtualName	string	Y	Scan engine name
login	string	Y	Scan engine username
password	string	Y	Scan engine password
notes	string	N	Notes
doNotUpdate	bool	N	Do 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 post /AppSpiderEnterprise/rest/v1/Engine/DeleteEngine

Description

Deletes a scan engine(s)

Parameters

Name	Type	Required	Description
ids	guid[]	Y	Scan engine IDs

Response Messages

Response status code	Reason	Description
200		Scan engine(s) removed
400	InvalidJsonSchema	Required 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