Get Report
Nyx Endpoints
Get Report
Download the full markdown audit report for a completed Nyx run
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.Path Parameters
The
run_id returned by POST /nyx/runs.Headers
Use
text/markdown to receive the report body. Defaults to text/markdown if omitted.Response
Atext/markdown body containing the audit report. The CLI writes it to <output>/<config_name>-report.md.
Example
Errors
| Status | Meaning |
|---|---|
| 401 | Invalid or expired X-Verification-Token |
| 404 | run_id not found |
| 425 | Run is still in progress, report not ready yet |
Related Endpoints
- POST /nyx/runs: submit a new run
- GET /nyx/runs/: poll for completion