Report

Report Generation

Generates a configured report and returns the instance identifier of the report.

post/api/3/reports/{id}/generate

Request

Base URL
https://<host>:<port>
Auth
none declared
TypeScript
https://skmtc.dev/rapid7/apis/rapid7-vm-api/docs/api/3/reports/:id/generate/post.ts
A function with typed inputs. Its response is checked against the schema.

idinteger required

The identifier of the report.

idinteger

The identifier of the report instance.

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