RArapid7
Scan

Site Scans

Changed on

Starts a scan for the specified site.

post/api/3/sites/{id}/scans

Request

Path parameters

idinteger required

The identifier of the site.

Query parameters

overrideBlackoutboolean

Whether to request for the override of an scan blackout window.

Request body

assetGroupIdsobject[]

The asset groups that should be included as a part of the scan. Only asset groups assigned to the site can be specified for a scan. This value should be an array of integers representing the unique identifiers of the asset groups.

engineIdinteger

The identifier of the scan engine.

hostsstring[]

The hosts that should be included as a part of the scan. This should be a mixture of IP Addresses and Hostnames as a String array.

namestring

The user-driven scan name for the scan.

templateIdstring

The identifier of the scan template

Response

OK

idobject

The identifier of the scan.

Example response

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ]
}

Changes

  • 3a8197c22d71Revision changes
    • info

      added optional request body

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status

    • info

      added the media type application/json;charset=UTF-8 for the response with the status