RArapid7
Report

Report History

Changed on

Returns the details for a generation of the report.

get/api/3/reports/{id}/history/{instance}

Request

Path parameters

idinteger required

The identifier of the report.

instancestring required
Example:latest

The identifier of the report instance. Valid values are 'latest' or any integer.

Response

OK

generatedstring date-time

The date the report finished generation.

idinteger

The identifier of the report instance.

status'aborted' | 'failed' | 'complete' | 'running' | 'unknown'

The status of the report generation process.

uristring uri

The URI of the report accessible through the web console. Refer to the Download relation hyperlink for a download URI.

Example response

{
  "generated": "2018-06-01T18:56:03Z",
  "id": 5,
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "size": {
    "bytes": 24789050,
    "formatted": "23.6 MB"
  },
  "status": "complete",
  "uri": "https://hostname:3780/reports/..."
}

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