Retrieve current state of all scans

GET /scans

Get the current state of scans running (if they are) on the site and any current progress.

Responses

  • • 200

    the current state of all scans

    Hide response attributes Show response attributes array[object]
    • enqueued_count integer

      the total number of enqueued scans

    • enqueued_status object

      the status of the current scans

      Hide enqueued_status attributes Show enqueued_status attributes
    • current_slug string

      the slug of the currently running scan

      Format should match the following pattern: ^[a-z_]$.

    • current_name string

      the name of the currently running scan

      Format should match the following pattern: ^[a-z_]$.

    • progress number

      the overall progress (as a percentage) of completion of all scans in the current queue
  • • 400

    bad input parameter

GET /scans 
curl \
 -X GET https://virtserver.swaggerhub.com/Fernleaf-Systems/ShieldSecurity/1.0.0/scans
Response examples (200) 
[
  {
    "enqueued_count": 1,
    "enqueued_status": {
      "afs": true,
      "apc": false,
      "wpv": false
    },
    "current_slug": "afs",
    "current_name": "afs",
    "progress": 0.641028
  }
]