RArapid7
Report

Report Template

Changed on

Returns the details of a report template. Report templates govern the contents generated within a report.

get/api/3/report_templates/{id}

Request

Path parameters

idstring required

The identifier of the report template;

Example:audit-report

Response

OK

builtinboolean

Whether the report template is builtin.

descriptionstring

The description of the report template.

idobject

The identifier of the report template;

namestring

The name of the report template.

sectionsstring[]

The sections that comprise the document report template.

type'document' | 'export' | 'file'

The type of the report template. document is a templatized, typically printable, report that has various sections of content. export is data-oriented output, typically CSV. file is a printable report template using a report template file.

Example response

{
  "builtin": true,
  "description": "Provides comprehensive details about discovered assets, vulnerabilities, and users.",
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "name": "Audit Report",
  "type": "document"
}

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