Get debug bundle
Bundled debugging payload for a run, suite, or test case, as JSON or Markdown.
Quick Reference
Pick the scope
At least 1 ofrunId, suiteId, or caseId is required.If multiple IDs are passed, the most-specific scope wins.
Parent ID rules
suiteIdrequiresrunId. The API returns400ifsuiteIdis passed withoutrunId.caseIdcan be sent withoutrunId. The service resolves the latest run for that case and returns it indata.meta.runId.
Response formats and view modes
- curl
- PowerShell
Parameters that do not apply are rejected
A parameter that cannot take effect at the resolved scope returns400 VALIDATION_ERROR rather than being ignored:
viewother thanfullat run scope.attemptwithoutcaseId.pageorlimitwith a non-default value at test scope.budgetCharswithoutas=markdown.- Any parameter sent more than once.
view=full, page=1, limit=10) is accepted at every scope.
Response fields by scope
run and suite scopes page their items[], and report that paging in the standard
pagination object beside data: page, limit, total, hasNext, hasPrev. The test
scope returns a single test and is not paginated.
failureWindow contains the before, failed, and after steps around the failure. Each attemptHistory entry carries its own 0-based attempt index, so you can request that attempt directly with attempt=N.
Links block in every response
Each scope includeslinks.uiUrl and links.retryCommand.Test-scope responses also include
links.traceViewerUrl, or null when trace data is unavailable.Path Parameters
Query Parameters
Payload size mode. Test scope: brief drops steps[]; headline also drops stdout and stderr and caps artifacts.* arrays at 5 with a totals field. Suite scope: brief and headline set each item's failureWindow to null. Run scope: only full is accepted; any other value returns 400.
full, brief, headline Response
Standard envelope: { success, data }. data is discriminated by data.scope:
"run":{ scope, runId, runStatus, suites[], items[] (each with alsoFailedIn[]), meta, environment, links }"suite":{ scope, spec, suiteStatus, items[] (each with failureWindow; null under view=brief or headline), meta, environment, links }"test":{ scope, spec, test, error, attemptHistory[] (each with its own 0-based attempt index; the selected attempt is excluded), traceLink, failureWindow, steps[], stdout, stderr, artifacts, meta, environment, links }
The run and suite scopes also return the standard pagination object
(page, limit, total, hasNext, hasPrev) beside data, not inside it.
The test scope is not paginated.
failureWindow has before, failed, and after steps.
With ?as=markdown the body is a Markdown document whose sections depend on scope:
run: Failing suites, Failing tests, Actions. Suite: Failing tests (each with Error and
Failure window), Actions. Test: Error, Failure window, Steps, stdout, stderr, Attempt
history, Artifacts, Actions.