RArapid7
Scan

Scan

Changed on

Returns the specified scan.

get/api/3/scans/{id}

Request

Path parameters

idinteger required

The identifier of the scan.

Example:28

Response

OK

assetsinteger

The number of assets found in the scan.

durationstring

The duration of the scan in ISO8601 format.

endTimestring date-time

The end time of the scan in ISO8601 format.

engineIdobject

The identifier of the scan engine.

engineNamestring

The name of the scan engine.

idobject

The identifier of the scan.

messagestring

The reason for the scan status.

scanNamestring

The user-driven scan name for the scan.

scanTypestring

The scan type (automated, manual, scheduled).

startTimestring date-time

The start time of the scan in ISO8601 format.

startedBystring

The name of the user that started the scan.

startedByUsernamestring

The username of the user that started the scan.

status'aborted' | 'unknown' | 'running' | 'finished' | 'stopped' | 'error' | 'paused' | 'dispatched' | 'integrating'

The scan status.

Example response

{
  "engineIds": {
    "id": 11
  },
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "vulnerabilities": {
    "critical": 16,
    "moderate": 3,
    "severe": 76,
    "total": 95
  }
}

Changes

  • 3a8197c22d71Revision changes
    • 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