API Scan Actions

Note

Scan actions are executed in an asynchronous manner by backend processes and may take some time to finish. For example, pausing a scan requires the scan to reach a stable point. Therefore, the success return value is only an indication that the action was accepted by the system (correct IDs, permissions, and state of the scan).

To verify that an action was successful, you have to check the scan status with GET /api/v1/(api_key)/scan/(scan_id)/status.

POST /api/v1/(api_key)/scan/(scan_id)/start

New in version 1.0.

Run a scan.

Example request:

POST /api/v1/3079080045dfdc3b24966d972e890bd2/scan/6e543cfc52004489/start 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: 70
Date: Wed, 08 May 2019 11:26:39 GMT

{
  "message": "Starting scan has been initiated",
  "success": true
}
Parameters:
  • api_key (string) – Your API key
  • scan_id (string) – ID of the scan
Response Headers:
 
Response JSON Object:
 
  • success (boolean) – action was accepted
  • message (string) – human readable response
Status Codes:
POST /api/v1/(api_key)/scan/(scan_id)/abort

New in version 1.0.

Abort a running scan.

Example request:

POST /api/v1/3079080045dfdc3b24966d972e890bd2/scan/6e543cfc52004489/abort 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: 70
Date: Wed, 08 May 2019 11:26:56 GMT

{
  "message": "Aborting scan has been initiated",
  "success": true
}
Parameters:
  • api_key (string) – Your API key
  • scan_id (string) – ID of the scan
Response Headers:
 
Response JSON Object:
 
  • success (boolean) – action was accepted
  • message (string) – human readable response
Status Codes:
POST /api/v1/(api_key)/scan/(scan_id)/pause

New in version 1.0.

Pause a running scan.

Example request:

POST /api/v1/3079080045dfdc3b24966d972e890bd2/scan/6e543cfc52004489/pause 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: 69
Date: Wed, 08 May 2019 11:26:23 GMT

{
  "message": "Pausing scan has been initiated",
  "success": true
}
Parameters:
  • api_key (string) – Your API key
  • scan_id (string) – ID of the scan
Response Headers:
 
Response JSON Object:
 
  • success (boolean) – action was accepted
  • message (string) – human readable response
Status Codes:
See also:
POST /api/v1/(api_key)/scan/(scan_id)/resume

New in version 1.0.

Resume a paused scan.

Example request:

POST /api/v1/2040190dafba3cdae1fb48eb6195906c/scan/2fb76ae990484dc9/resume 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: 70
Date: Wed, 08 May 2019 11:27:36 GMT

{
  "message": "Resuming scan has been initiated",
  "success": true
}
Parameters:
  • api_key (string) – Your API key
  • scan_id (string) – ID of the scan
Response Headers:
 
Response JSON Object:
 
  • success (boolean) – action was accepted
  • message (string) – human readable response
Status Codes:
See also: