Scan Engine Group Operations

Credential Warning

Note that System Administrator credentials are required to work with scan engines

get

/AppSpiderEnterprise/rest/v1/GetAllEngineGroups

Description Retrieves the list of scan engine groups

Parameters No paramaters

Response Messages

Response status code

Reason

200

OK

Response example:

JSON schema:
1
{
2
    "type": "object",
3
    "properties": {
4
        "EngineGroups": {
5
            "type": "array",
6
            "properties": {
7
                   "Id": {
8
                             "type": "string",
9
                             "required": true
10
                   },
11
                   "Name": {
12
                              "type": "string",
13
                              "required": true,
14
                              "maxLength": 128
15
                   },
16
                   "Description": {
17
                               "type": ["string", "null"]
18
                               "required": true,
19
                               "maxLength": 256
20
                   },
21
                   "Monitoring": {
22
                               "type": "boolean",
23
                               "required": true,
24
                    }
25
  }
26
  },
27
  "additionalProperties": false
28
},
29
     "IsSuccess": {
30
         "type": "boolean",
31
         "required": true
32
      },
33
      "ErrorMessage": {
34
           "type": ["string", "null"],
35
           "required": true
36
      "Reason": {
37
          "type": ["string", "null"],
38
          "required": true
39
      }
40
   },
41
   "additionalProperties": false
42
}
get

/AppSpiderEnterprise/rest/v1/EngineGroup/GetEngineGroupsForClient

Description Retrieves the list of scan engine groups for a client.

Credential Warning

Note: user permissions required to retrieve the list of scan engine groups. List will be restricted to the client that the user has access to.

Parameters No Parameters

Response Messages

Response status code

Reason

200

OK

Response example:

json
1
{
2
  "Type": "object",
3
  "properties": {
4
    "EngineGroups": {
5
      "type": "array",
6
      "properties": {
7
        "Id": {
8
          "type": "string",
9
          "required": true
10
        },
11
        "Name": {
12
          "type": "string",
13
          "required": true,
14
          "maxLength": 128
15
        },
16
        "Description": {
17
          "type": ["string", "null"],
18
          "required": true,
19
          "maxLength": 256
20
        },
21
        "Monitoring": {
22
          "type": "boolean",
23
          "required": true
24
        }
25
      }
26
    },
27
    "additionalProperties": false
28
  },
29
  "IsSuccess": {
30
    "type": "boolean",
31
    "required": true
32
  },
33
  "ErrorMessage": {
34
    "type": ["string", "null"],
35
    "required": true
36
  },
37
  "Reason": {
38
    "type": ["string", "null"],
39
    "required": true
40
  }
41
},
42
"additionalProperties": false
43
}
post

/AppSpiderEnterprise/rest/v1/EngineGroup/SaveEngineGroup

Description Creates or updates a scan engine group

Parameters

Name

Type

Required

Description

id

string

N

If id not provided a new engine group will be created. If an id is provided then an engine group update is performed.

name

string

Y

Scan engine group name. Name should be unique

description

string

N

Scan engine group description

monitoring

bool

N

Scan engine group is monitoring

Response Messages

Response status code

Reason

Description

200

Scan engine group created

400

InvalidJsonSchema

Required parameters not provided

400

EngineGroupNameIsNotUnique

Engine group name is not unique

400

EngineGroupNotFound

Engine group with provided id not found

Response example:

JSON scheme:
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
}
post

/AppSpiderEnterprise/rest/v1/EngineGroup/DeletEngineGroup

Description Deletes a scan engine group

Parameters

Name

Type

Required

Description

ids

guid[]

Y

Scan engine group IDs

Response Messages

Response status code

Reason

Description

200

Scan engine group 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": true
10
    },
11
    "Reason": {
12
      "type": ["string", "null"],
13
      "required": true
14
    }
15
  },
16
  "additionalProperties": false
17
}
post

/AppSpiderEnterprise/rest/v1/EngineGroup/AddEngineToGroup

Description Adds a scan engine to a scan engine group

Parameters

Name

Type

Required

Description

groupId

guid

Y

Scan engine group ID

engineId

guid

Y

Scan engine ID

Response Messages

Response status code

Reason

Description

200

Scan engine added to scan engine group

400

InvalidJsonSchema

Required parameters not provided

400

EngineNotFound

Scan engine with engineId not found

400

EngineGroupNotFound

Scan engine group with groupId not found

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
}
post

/AppSpiderEnterprise/rest/v1//EngineGroup/DeleteEngineFromGroup

Description Deletes scan engine from scan engine group

Parameters

Name

Type

Required

Description

groupId

guid

Y

Scan engine group ID

engineId

guid

Y

Scan engine ID

Response Messages

Response status code

Reason

Description

200

Scan engine deleted from scan engine group

400

InvalidJsonSchema

Required parameters not provided

400

EngineNotFound

Scan engine with engineId not found

400

EngineGroupNotFound

Scan engine group with grouId not found

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
}