Export Report

Exports a report and its data to a PDF, JSON, or CSV file. The response is a ZIP file stream containing the exported file with the naming convention <file_name>.pdf|json|csv. The report ID can be retrieved using the Get Reports List endpoint.

Two mandatory query parameters must be provided: file_name (desired file name without suffix) and format (pdf, json, or csv).

For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can export a report in the scope of a project by using the additional query parameter projectKey.

Requires a user with the Manage Reports role. Since Xray 3.8.

Path Params
string
required

The unique identifier of the report to export.

Query Params
string
required

The desired file name for download (without a suffix).

string
enum
required

Export format: pdf, json, or csv.

Allowed:
string

Project scope (when Projects are enabled).

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/zip
application/json