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:

JSON schema:
1
{
2
    "type": "object",
3
    "properties": {
4
        "Engines": {
5
            "type": "array",
6
            "properties": {
7
                   "Id": {
8
                             "type": "string",
9
                             "required": true
10
                   },
11
                   "Url": {
12
                              "type": "string",
13
                              "required": true,
14
                              "maxLength": 512
15
                   },
16
                   "Login": {
17
                               "type": "string",
18
                               "required": true,
19
                               "maxLength": 32
20
                   },
21
                   "Password": {
22
                               "type": "string",
23
                               "required": true,
24
                               "maxLength": 32
25
                   },
26
                   "Notes": {
27
                               "type": ["string", "null"]
28
                               "required": true,
29
                               "maxLength": 512
30
                   },
31
                   "IsBeingUpdated": {
32
                               "type": "boolean",
33
                               "required": true,
34
                   },
35
                   "DoNotUpdate": {
36
                               "type": "boolean",
37
                               "required": true,
38
                   },
39
                   "Type": {
40
                               "type": "string",
41
                               "required": true,
42
                    },
43
                    "VirtualName": {
44
                               "type": "string",
45
                               "required": true,
46
                               "maxLength": 50   
47
                    }
48
  }
49
  },
50
  "additionalProperties": false
51
},
52
     "IsSuccess": {
53
         "type": "boolean",
54
         "required": true
55
      },
56
      "ErrorMessage": {
57
           "type": ["string", "null"],
58
           "required": true
59
      "Reason": {
60
          "type": ["string", "null"],
61
          "required": true
62
      }
63
   },
64
   "additionalProperties": false
65
}

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 :////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

200

Scan engine created

400

InvalidJsonSchema

Required parameters not provided

400

EngineNotFound

Provided url doesn't match URL schema

400

EngineNameIsNotUnique

Engine name is not unique

Response example:

JSON schema:
1
{
2
    "type": "object",
3
    "properties": {
4
        "IsSuccess": {
5
            "type": "boolean",
6
            "required": true
7
        },   
8
        "ErrorMessage": {
9
            "type": ["string", "null" ],
10
            "required": true
11
        },    
12
        "Reason": {
13
            "type": ["string", "null" ],
14
        }
15
   },
16
 "additionalProperties": false
17
}

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:

JSON schema:
1
{
2
    "type": "object",
3
    "properties": {
4
        "IsSuccess": {
5
            "type": "boolean",
6
            "required": true
7
        },   
8
        "ErrorMessage": {
9
            "type": [ "string", "null" ],
10
            "required": true
11
        },   
12
        "Reason": {
13
            "type": [ "string", "null" ],
14
            "required": true
15
        }
16
     },
17
   "additionalProperties": false
18
}

Reference Guide

/Engine/DeleteEngine