Generate a Recovery Test Report

Creates a Recovery Test Report for a recovery that covers the requested applications, and returns the new report's ID along with a URL to download its PDF.

By default the report covers the most recent recovery test that includes every requested application. Supply recoveryId to report on a specific recovery instead, which is how you report on an older recovery or re-report on one you have already reported on.

A report can be rendered in two variants: summary, and detailed, which adds the issue-summary tables. Choose them with reportTypes; either variant can be rendered from any report, at any time.

The PDF itself is not stored. It is re-rendered on demand from the report's saved data, so the same report always produces the same document.

Requires the Recovery Reports capability on the account; without it the request fails with 422.

post/api/accounts/{account_id}/recovery-reports

Request

  • Base URL: https://api.arpio.io
  • URL: https://api.arpio.io/api/accounts/{account_id}/recovery-reports
  • Auth: one of:
    • API key in header X-Api-Key
    • API key in cookie ArpioSession

Response

The new report's ID, metadata, and a URL to download its PDF. When renderPdf is true, also pdfUrls (one URL per rendered variant) and downloadUrl — a single link, which is a zip archive if more than one variant was rendered. Those URLs expire after 5 minutes.

Changes

No recorded changes to this operation across all 1 revision of this API.