API Scan Configuration

POST /api/v1/(api_key)/scan/new

New in version 1.0.

Create a new scan definition.

Example request:

POST /api/v1/3079080045dfdc3b24966d972e890bd2/scan/new HTTP/1.1
Host: api.appcheck-ng.com
Accept-Encoding: identity
Content-Length: 99
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

name=Some+scan&targets=example.com&targets=http%3A%2F%2Fexample.com&profile_id=1a5f8360cdf945ca

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 110
Date: Wed, 08 May 2019 11:26:05 GMT

{
  "errors": null,
  "message": "Scan has been created",
  "scan_id": "ba1191a671bf4ba5",
  "success": true
}
Parameters:
  • api_key (string) – Your API key
Form Parameters:
 
  • name – name to identify the scan definition
  • targets – (multiple) URL, hostname, or IP address
  • profile_id – (optional) ID of a profile to apply
  • scan_hub – (optional) Which scanhub or hub group to use
Response Headers:
 
Response JSON Object:
 
  • success (boolean) – operation was successful
  • message (string) – human readable response
  • errors (strings) – detailed list of errors
  • scan_id (string) – ID of the created scan definition
Status Codes:

New in version 1.1: The profile_id parameter

New in version 1.2: The scan_hub parameter

See also:
POST /api/v1/(api_key)/scan/(scan_id)/update

New in version 1.0.

Update a scan definition.

Example request:

POST /api/v1/3079080045dfdc3b24966d972e890bd2/scan/6e543cfc52004489/update HTTP/1.1
Host: api.appcheck-ng.com
Accept-Encoding: identity
Content-Length: 103
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

name=Fancier+name&targets=example.com&targets=https%3A%2F%2Fexample.com&profile_id=1a5f8360cdf945ca

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 77
Date: Wed, 08 May 2019 11:27:12 GMT

{
  "errors": null,
  "message": "Scan has been updated",
  "success": true
}
Parameters:
  • api_key (string) – Your API key
  • scan_id (string) – ID of the scan
Form Parameters:
 
  • name – (optional) name to identify the scan definition
  • targets – (optional, multiple) URL, hostname, or IP address
  • profile_id – (optional) ID of a profile to overwrite settings with
  • scan_hub – (optional) The scan hub to run the scan from
Response Headers:
 
Response JSON Object:
 
  • success (boolean) – operation was successful
  • message (string) – human readable response
  • errors (strings) – detailed list of errors
Status Codes:

New in version 1.1: The profile_id parameter

New in version 1.2: The scan_hub parameter

See also:
POST /api/v1/(api_key)/scan/(scan_id)/delete

New in version 1.0.

Delete a scan definition and all associated runs.

Example request:

POST /api/v1/3079080045dfdc3b24966d972e890bd2/scan/6e543cfc52004489/delete HTTP/1.1
Host: api.appcheck-ng.com
Accept-Encoding: identity
Content-Length: 0

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 59
Date: Wed, 08 May 2019 11:25:49 GMT

{
  "message": "Scan has been deleted",
  "success": true
}
Parameters:
  • api_key (string) – Your API key
  • scan_id (string) – ID of the scan
Response Headers:
 
Response JSON Object:
 
  • success (boolean) – operation was successful
  • message (string) – human readable response
Status Codes: