Skip to main content
GET
/
nyx
/
runs
/
{run_id}
Get Run
curl --request GET \
  --url https://api.example.com/nyx/runs/{run_id}
{
  "run_id": "<string>",
  "config_name": "<string>",
  "name": "<string>",
  "status": {},
  "result": {},
  "budget_usd": 123,
  "spent_usd": 123,
  "attempts_completed": 123,
  "findings_count": 123,
  "created_at": {},
  "updated_at": {},
  "completed_at": {}
}

​
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

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

​
Response

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

​
Example

curl https://api.fabraix.com/v1/nyx/runs/r_01H2X3Y4Z5 \
  -H "X-Verification-Token: $NYX_TOKEN"

​
Running

{
  "run_id": "r_01H2X3Y4Z5",
  "config_name": "playground",
  "name": "Fabraix Playground: The Gatekeeper",
  "status": "running",
  "result": null,
  "budget_usd": 5.00,
  "spent_usd": 1.23,
  "attempts_completed": 7,
  "findings_count": 0,
  "created_at": "2026-04-18T14:30:45.123Z",
  "updated_at": "2026-04-18T14:35:12.456Z",
  "completed_at": null
}

​
Completed: Vulnerability Found

{
  "run_id": "r_01H2X3Y4Z5",
  "config_name": "playground",
  "name": "Fabraix Playground: The Gatekeeper",
  "status": "completed",
  "result": "success",
  "budget_usd": 5.00,
  "spent_usd": 2.87,
  "attempts_completed": 14,
  "findings_count": 1,
  "created_at": "2026-04-18T14:30:45.123Z",
  "updated_at": "2026-04-18T14:42:01.789Z",
  "completed_at": "2026-04-18T14:42:01.789Z"
}
When result is "success", fetch the report to see the finding details.