Initiate new scans

POST /scans

Initiate new scans to run asynchronously from the request

Query parameters

  • scan_slugs array[string]

    a comma-separated list of scan slugs for scans to initiate

Body

Option item to update

Responses

  • 201

    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 object
    • 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

    invalid input, object invalid

  • 500

    scans already running

POST /scans 
curl \
 -X POST https://virtserver.swaggerhub.com/Fernleaf-Systems/ShieldSecurity/1.0.0/scans \
 -H "Content-Type: application/json" \
 -d '{"enqueued_count":1}'
Request example 
{
  "enqueued_count": 1
}
Request examples 
{
  "enqueued_count": 1
}
Response examples (201) 
[
  {
    "enqueued_count": 1,
    "enqueued_status": {
      "afs": true,
      "apc": false,
      "wpv": false
    },
    "current_slug": "afs",
    "current_name": "afs",
    "progress": 0.641028
  }
]
Response examples (201) 
[
  {
    "enqueued_count": 1,
    "enqueued_status": {
      "afs": true,
      "apc": false,
      "wpv": false
    },
    "current_slug": "afs",
    "current_name": "afs",
    "progress": 0.641028
  }
]