NFnforgeio
reports
enterprise

Send a report.

Generate and send a report. This API waits for the report to be generated before returning. We recommend that you set the client’s timeout to at least 60 seconds. Available to org admins only and with a valid license.

Only available in Grafana Enterprise v7.0+. This API endpoint is experimental and may be deprecated in a future release. On deprecation, a migration strategy will be provided and the endpoint will remain functional until the next major release of Grafana.

You need to have a permission with action reports:send.

post/reports/email

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/reports/email
  • Auth
    • HTTP basic
    • or API key in header Authorization

Request body

emailstring
emailsstring

Comma-separated list of emails to which to send the report to.

idstring int64

Send the report to the emails specified in the report. Required if emails is not present.

useEmailsFromReportboolean

Send the report to the emails specified in the report. Required if emails is not present.

Response

An OKResponse is returned if the request was successful.

messagestring

Changes

No recorded changes to this operation across all 2 revisions of this API.