Scan Configuration Operations

Credential Warning

Note: client account permissions required to modify scan configurations. Configs will be restricted to the client that the user has access to. The user account should have "Config Manager" permissions to work with configs.

post

/AppSpiderEnterprise/rest/v1/Config/SaveConfig

Description Creates a new scan configuration

Parameters

Name

Type

Required

Description

id

guid[]

N

If id not provided new config will be created. If id provided config update performed.

xml

string

Y

Scan config xml file. Config name should be unique in the client.

defendEnabled

bool

N(false)

AppSpider Defend enabled

monitoring

bool

N(false)

Monitoring scanning enabled

monitoringDelay

int

N(0)

Delay between monitoring scans in hours. Possible values are 1 (hour), 24 (day), 168 (week), 720 (month)

monitoringTriggerScan

bool

N(false)

Monitoring scan triggers attack scan if changes found

name

string

Y

Config name

engineGroupId

guid[]

Y

Engine group id for scan config

isApproveRequired

bool

N(false)

Approve required property

config flies are send as part of a multipart/form-data request. For more information see the API Reference

Response status code

Reason

Description

200

Scan config created

400

InvalidJsonSchema

Required parameters not provided

400

ConfigNotFound

Scan config with Id not found

400

ConfigNameIsNotUnique

Scan config with the same name already exist in the client

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/Config/DeleteConfigs

Description Deletes a scan config

Parameters

Name

Type

Required

Description

configIds

guid[]

Y

Scan config IDs

deleteReport

bool

N(false)

Remove all reports related to scan configs

deletePendingScan

bool

N(false)

Remove all pending scans related to scan configs

Response Messages

Response status code

Reason

Description

200

Scan config 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
}
19
get

/AppSpiderEnterprise/rest/v1/Config/GetConfigs

Description Retrieves all scan configs for the client

Parameters No parameters

Response Messages

Response status code

Reason

Description

200

Response contains the list of scan configs

Response example:

JSON schema:
1
{
2
"type": "object",
3
"properties": {
4
"Configs": {
5
"type": "array",
6
"items": {
7
"type": "object",
8
"properties": {
9
"Id": {
10
"type":"string",
11
"required": true
12
},
13
"Name": {
14
"type":"string",
15
"required": true
16
},
17
"ClientId": {
18
"type":"string",
19
"required": true
20
},
21
"EngineGroupId": {
22
"type":"string",
23
"required": true
24
},
25
"Monitoring": {
26
"type": "boolean",
27
"required": true
28
},
29
"IsApproveRequired": {
30
"type": "boolean",
31
"required": true
32
},
33
"DefendEnabled": {
34
"type": "boolean",
35
"required": true
36
},
37
"MonitoringDelay": {
38
"type": "integer",
39
"required": true
40
},
41
"MonitoringTriggerScan": {
42
"type": "boolean",
43
"required": true
44
},
45
"Xml": {
46
"type": "string",
47
"required": true
48
}
49
}
50
},
51
"additionalProperties": false
52
},
53
"IsSuccess": {
54
"type": "boolean",
55
"required": true
56
},
57
"ErrorMessage": {
58
"type":["string", "null"],
59
"required": true
60
},
61
"Reason": {
62
"type":["string", "null"],
63
"required": true
64
}
65
},
66
"additionalProperties": false
67
}

/AppSpiderEnterprise/rest/v1/Config/GetConfigs

Description Retrieves all scan configs for the client using paging

Parameters

Parameters

Type

Required

Description

page

int

Y

The page of results to return (page starts at 0)

pageSize

int

Y

The number of results to return per page

Response Messages

Response status code

Reason

Description

200

Response contains the list of scan configs

Response example:

json
1
{
2
"type": "object",
3
"properties": {
4
"Configs": {
5
"type": "array",
6
"items": {
7
"type": "object",
8
"properties": {
9
"Id": {
10
"type":"string",
11
"required": true
12
},
13
"Name": {
14
"type":"string",
15
"required": true
16
},
17
"ClientId": {
18
"type":"string",
19
"required": true
20
},
21
"EngineGroupId": {
22
"type":"string",
23
"required": true
24
},
25
"Monitoring": {
26
"type": "boolean",
27
"required": true
28
},
29
"IsApproveRequired": {
30
"type": "boolean",
31
"required": true
32
},
33
"DefendEnabled": {
34
"type": "boolean",
35
"required": true
36
},
37
"MonitoringDelay": {
38
"type": "integer",
39
"required": true
40
},
41
"MonitoringTriggerScan": {
42
"type": "boolean",
43
"required": true
44
},
45
"Xml": {
46
"type": "string",
47
"required": true
48
}
49
}
50
},
51
"additionalProperties": false
52
},
53
"IsSuccess": {
54
"type": "boolean",
55
"required": true
56
},
57
"ErrorMessage": {
58
"type":["string", "null"],
59
"required": true
60
},
61
"Reason": {
62
"type":["string", "null"],
63
"required": true
64
}
65
},
66
"additionalProperties": false
67
}

/AppSpiderEnterprise/rest/v1/Config/GetConfigs

Description Retrieves the list of scan configs for the client by the target id

Parameters

Parameters

Type

Required

Description

targetId

guid[]

Y

The target id

Response Messages

Response status code

Reason

Description

200

Response contains the list of scan configs

400

ConfigNotFound

No Scan configs exist for target id

Response example:

json
1
{
2
"type": "object",
3
"properties": {
4
"Configs": {
5
"type": "array",
6
"items": {
7
"type": "object",
8
"properties": {
9
"Id": {
10
"type":"string",
11
"required": true
12
},
13
"Name": {
14
"type":"string",
15
"required": true
16
},
17
"ClientId": {
18
"type":"string",
19
"required": true
20
},
21
"EngineGroupId": {
22
"type":"string",
23
"required": true
24
},
25
"Monitoring": {
26
"type": "boolean",
27
"required": true
28
},
29
"IsApproveRequired": {
30
"type": "boolean",
31
"required": true
32
},
33
"DefendEnabled": {
34
"type": "boolean",
35
"required": true
36
},
37
"MonitoringDelay": {
38
"type": "integer",
39
"required": true
40
},
41
"MonitoringTriggerScan": {
42
"type": "boolean",
43
"required": true
44
},
45
"Xml": {
46
"type": "string",
47
"required": true
48
}
49
}
50
},
51
"additionalProperties": false
52
},
53
"IsSuccess": {
54
"type": "boolean",
55
"required": true
56
},
57
"ErrorMessage": {
58
"type":["string", "null"],
59
"required": true
60
},
61
"Reason": {
62
"type":["string", "null"],
63
"required": true
64
}
65
},
66
"additionalProperties": false
67
}

/AppSpiderEnterprise/rest/v1/Config/GetConfigs

Description Retrieves the list of scan configs for the client by the target id using paging

Parameters

Parameters

Type

Required

Description

targetId

guid[]

Y

The target id

page

int

Y

The page of results to return (page starts at 0)

pageSize

int

Y

The number of results to return per page

Response Messages

Response status code

Reason

Description

200

Response contains the list of scan configs

400

ConfigNotFound

No Scan configs exist for target id

Response example:

json
1
{
2
"type": "object",
3
"properties": {
4
"Configs": {
5
"type": "array",
6
"items": {
7
"type": "object",
8
"properties": {
9
"Id": {
10
"type":"string",
11
"required": true
12
},
13
"Name": {
14
"type":"string",
15
"required": true
16
},
17
"ClientId": {
18
"type":"string",
19
"required": true
20
},
21
"EngineGroupId": {
22
"type":"string",
23
"required": true
24
},
25
"Monitoring": {
26
"type": "boolean",
27
"required": true
28
},
29
"IsApproveRequired": {
30
"type": "boolean",
31
"required": true
32
},
33
"DefendEnabled": {
34
"type": "boolean",
35
"required": true
36
},
37
"MonitoringDelay": {
38
"type": "integer",
39
"required": true
40
},
41
"MonitoringTriggerScan": {
42
"type": "boolean",
43
"required": true
44
},
45
"Xml": {
46
"type": "string",
47
"required": true
48
}
49
}
50
},
51
"additionalProperties": false
52
},
53
"IsSuccess": {
54
"type": "boolean",
55
"required": true
56
},
57
"ErrorMessage": {
58
"type":["string", "null"],
59
"required": true
60
},
61
"Reason": {
62
"type":["string", "null"],
63
"required": true
64
},
65
"TotalCount": {
66
"type": "integer",
67
"required": true
68
},
69
"TotalPages": {
70
"type": "integer",
71
"required": true
72
},
73
"Links": {
74
"type": "array",
75
"items": {
76
"Rel": {
77
"type":["string", "null"],
78
"required": true
79
},
80
"Href": {
81
"type":["string", "null"],
82
"required": true
83
}
84
}
85
}
86
},
87
},
88
"additionalProperties": false
89
}
get

/AppSpiderEnterprise/rest/v1/Config/GetConfig

Description Retrieves scan config for the client

Parameters

Parameters

Type

Required

Description

id

guid[]

Y

Scan config ID

Response Messages

Response status code

Reason

Description

200

Response contains the scan config

400

InvalidJsonSchema

Required parameters not provided

400

ConfigNotFound

Scan config with "id" not found in client

Response example:

JSON schema:
1
{
2
"type": "object",
3
"properties": {
4
"IsSuccess": {
5
"type": "boolean",
6
"required": true
7
},
8
"Config": {
9
"type": ["object", "null"],
10
"required": true,
11
"properties": {
12
"Id": {
13
"type": "string",
14
"required": true
15
},
16
"Name": {
17
"type": "string",
18
"required": true
19
},
20
"ClientId": {
21
"type": "string",
22
"required": true
23
},
24
"EngineGroupId": {
25
"type": "string",
26
"required": true
27
},
28
"Monitoring": {
29
"type": "boolean",
30
"required": true
31
},
32
"IsApproveRequired": {
33
"type": "boolean",
34
"required": true
35
},
36
"DefendEnabled": {
37
"type": "boolean",
38
"required": true
39
},
40
"MonitoringDelay": {
41
"type": "integer",
42
"required": true
43
},
44
"MonitoringTriggerScan": {
45
"type": "boolean",
46
"required": true
47
},
48
"Xml": {
49
"type": "string",
50
"required": true
51
}
52
},
53
"additionalProperties": false
54
},
55
"ErrorMessage": {
56
"type": ["string", "null"],
57
"required": true
58
},
59
"Reason": {
60
"type": ["string", "null"],
61
"required": true
62
}
63
},
64
"additionalProperties": false
65
}
get

/AppSpiderEnterprise/rest/v1/Config/GetAttachment

Description Retrieves auxiliary files (such as macro, traffic recording, etc), referenced in the scan configuration

Parameters

Name

Type

Required

Description

configId

guid[]

Y

Scan config ID

fileName

string

Y

Name of requested file

fileType

string

Y

File type. Values are: "Authentication", "Certificate", "Crawling", "Selenium", "Traffic", "Wsdl"

Response Messages

Response status code

Reason

Description

200

Response contains the scan config attachment

400

InvalidJsonSchema

Required parameters not provided

400

ConfigNotFound

Scan config with 'configId' not found in client

400

FileNotFound

File with 'name' and 'fileType' not found or user has no access to config

Response example: File response from valid request. If error occurred

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

/AppSpiderEnterprise/rest/v1/Config/GetAttachments

Description Retrieves auxiliary files (such as macro, traffic recording, etc), referenced in the scan configuration

Parameters

Name

Type

Required

Description

configId

guid[]

Y

Scan config ID

Response Messages

Response status code

Reason

Description

200

Response contains the list of scan config attachments

400

InvalidJsonSchema

Required parameters not provided

400

ConfigNotFound

Scan config with 'id' not found in client or user has no access to config

400

FileNotFound

Files related to configs are not found on the server

Response example: ZIP file results from valid request. If error occurred

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
}