Skip to main content
GET
Get Run

Overview

Returns the full state of a Nyx run. Poll this endpoint after submitting a run until status reaches a terminal state (completed, failed, or cancelled). The CLI polls every 5 seconds; client code should respect a similar cadence.

Path Parameters

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

Response

string
required
string
required
string
required
Human-readable audit name.
enum
required
One of: "queued", "running", "completed", "failed", "cancelled".
enum | null
required
Terminal outcome. null while running, otherwise:
  • "success": vulnerability found
  • "exhausted": budget exhausted, no finding
  • "error": internal failure
number
required
Configured budget cap.
number
required
Cumulative spend so far.
integer
required
Number of probe attempts Nyx has finished.
integer
required
Number of vulnerabilities saved during the run.
datetime
required
datetime
required
datetime | null
required
Set once the run reaches a terminal state.

Example

Running

Completed: Vulnerability Found

When result is "success", fetch the report to see the finding details.