Skip to main content
Ask GitHub to rerun failed jobs and their dependents

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Headers

X-CSRF-Token
string

Session-bound CSRF token. Required for browser-session calls, together with a matching configured Origin header; omit it when calling with an API key.

Idempotency-Key
string

Optional for this operation. Preserve the same stable identifier when retrying an uncertain response; never reuse it for new work. If omitted where allowed, Cloud generates a request-scoped key that cannot reconcile a later retry. Do not include credentials or payloads. Stable identifier for one logical mutation.

Required string length: 1 - 128

Path Parameters

run_id
string
required

Workspace-owned BoxRouter workflow-run projection ID, not a GitHub run ID.

Required string length: 1 - 128
Pattern: ^[^\u0000]*$

Response

Failed-jobs rerun accepted by GitHub; the next attempt is observed separately.

operation_id
string
required
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
run_id
string
required
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
action
enum<string>
required
Available options:
cancel,
rerun,
rerun_failed_jobs
scope
string
required
Allowed value: "entire_workflow"
outcome
enum<string>
required
Available options:
accepted,
unknown
github_run_id
string | null
required
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
run_attempt
integer | null
required
Required range: x >= 1