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
The config is send as part of a multipart/form-data request. And any associated files will be sent in the request.
Name | Type | Required | Description |
|---|---|---|---|
config | text | Y | Contains a set of parameters necessary to create a scan sconfig, see table below. |
fileType | file | N | The name of the file type which is associated with the config, for example, if the config requires a selenium authentication file, the name of this parameter is selenium and you would attach the selenium file. |
The parmeters which need to be included in the config are detailed in the table below.
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 |
Note that the XML config must be embedded in the JSON request, the body of the request must be of type "form-data", and that a "config" key must contain the configuration in XML format.
If you wish to send an associated file with the request, there must be a reference made to the xml in the <ScanConfig>, for example with a selenium authentication file, the following xml must be provide the path of the file
xml
A full breakout of all XML elements contained in a ScanConfig can be found at Scan Configuration Parameters
JSON Request example
JSON
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:
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:
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:
/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
/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
/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
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:
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:
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:
Did this page help you?