Skip to main content
Manja / GitHub
Schema1.1.4object

workflow-run

An invocation of a workflow

Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Workflow Run

object

An invocation of a workflow

artifacts_url string
required

The URL to the artifacts for the workflow run.

Example:https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts

cancel_url string
required

The URL to cancel the workflow run.

Example:https://api.github.com/repos/github/hello-world/actions/runs/5/cancel

check_suite_id integer
optional

The ID of the associated check suite.

Example:42

check_suite_node_id string
optional

The node ID of the associated check suite.

Example:MDEwOkNoZWNrU3VpdGU0Mg==

check_suite_url string
required

The URL to the associated check suite.

Example:https://api.github.com/repos/github/hello-world/check-suites/12

conclusion string
requirednullable

Example:neutral

created_at string (date-time)
required
event string
required

Example:push

head_branch string
requirednullable

Example:master

head_repository_id integer
optional

Example:5

head_sha string
required

The SHA of the head commit that points to the version of the workflow being run.

Example:009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

html_url string
required

Example:https://github.com/github/hello-world/suites/4

id integer
required

The ID of the workflow run.

Example:5

jobs_url string
required

The URL to the jobs for the workflow run.

Example:https://api.github.com/repos/github/hello-world/actions/runs/5/jobs

logs_url string
required

The URL to download the logs for the workflow run.

Example:https://api.github.com/repos/github/hello-world/actions/runs/5/logs

name string
optionalnullable

The name of the workflow run.

Example:Build

node_id string
required

Example:MDEwOkNoZWNrU3VpdGU1

previous_attempt_url string
optionalnullable

The URL to the previous attempted run of this workflow, if one exists.

Example:https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3

pull_requests array
requirednullable
rerun_url string
required

The URL to rerun the workflow run.

Example:https://api.github.com/repos/github/hello-world/actions/runs/5/rerun

run_attempt integer
optional

Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.

Example:1

run_number integer
required

The auto incrementing run number for the workflow run.

Example:106

run_started_at string (date-time)
optional

The start time of the latest run. Resets on re-run.

status string
requirednullable

Example:completed

updated_at string (date-time)
required
url string
required

The URL to the workflow run.

Example:https://api.github.com/repos/github/hello-world/actions/runs/5

workflow_id integer
required

The ID of the parent workflow.

Example:5

workflow_url string
required

The URL to the workflow.

Example:https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml