Get Reports List

Returns a paginated list of reports that have been generated. All pagination query parameters are mandatory (direction, page_num, num_of_rows, order_by).

For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can get a list of reports 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

Sort direction: asc or desc

Allowed:
integer
required
≥ 1

Page number (starting at 1)

integer
required
≥ 1

Rows per page

string
required

One of: name, type, author, start_time, status

string

Project scope (when Projects are enabled)

Body Params

Optional request body for filtering the reports list. If omitted or empty, all reports are returned (subject to pagination).

filters
object

Filter criteria for the reports list.

Response

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