Skip to main content
GET
Get Report

Overview

Returns the full audit report as markdown. The report includes findings, reproduction steps, and the attack chain Nyx used to surface each vulnerability.
Only available once a run reaches status: "completed". Calling it earlier returns 425 Too Early.

Path Parameters

string
required
The run_id returned by POST /nyx/runs.

Headers

string
Use text/markdown to receive the report body. Defaults to text/markdown if omitted.

Response

A text/markdown body containing the audit report. The CLI writes it to <output>/<config_name>-report.md.

Example

Errors