ReferenceHTTP APIGit Hub work
Read a workflow run in the session's repository
GET
Reads one Actions run: its status, conclusion, workflow file and branch. Needs actions on in the agent's release under the workspace ceiling; any run in the repository can be read, not only ones the platform started.
Scope: sessions:read (API key or cookie session).
header
AuthorizationBearer <token>For servers and scripts: an API key sent as an HTTP bearer token, Bearer <key>. It holds exactly the scopes it was issued with; a key issued before scopes existed holds none. It never needs the CSRF header, and it cannot manage agents, members, teams or API keys. Issue one in the web console under Settings → API keys; each operation names the scope it needs.
Scope: sessions:read
id*stringThe session's id.
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidrun_id*integerThe GitHub Actions workflow run's id.
Range
0 < value <= 9007199254740991The run.
application/json- response
id*integerRange
0 < value <= 9007199254740991path*stringhead_branch*string|nullstatus*string|nullconclusion*string|nullhtml_url*stringFormat
uricurl -X GET 'https://example.com/v1/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/github/workflow-runs/1'Example Response
{ "id": 9012345678, "status": "completed", "conclusion": "failure", "path": ".github/workflows/deploy-preview.yml", "head_branch": "main", "html_url": "https://github.com/acme/sample-app/actions/runs/9012345678"}