Search
K
GitHub v3 REST API

Artifact

object

An artifact

idintegerrequired

Example:5

node_idstringrequired

Example:MDEwOkNoZWNrU3VpdGU1

namestringrequired

The name of the artifact.

Example:AdventureWorks.Framework

size_in_bytesintegerrequired

The size in bytes of the artifact.

Example:12345

urlstringrequired

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

archive_download_urlstringrequired

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

expiredbooleanrequired

Whether or not the artifact has expired.

created_atstring(date-time)required
expires_atstring(date-time)required
updated_atstring(date-time)required
Example

Job

object

Information of a job execution in a workflow run

idintegerrequired

The id of the job.

Example:21

run_idintegerrequired

The id of the associated workflow run.

Example:5

run_urlstringrequired

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

run_attemptinteger

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

Example:1

node_idstringrequired

Example:MDg6Q2hlY2tSdW40

head_shastringrequired

The SHA of the commit that is being run.

Example:009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

urlstringrequired

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

html_urlstringrequired

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

statusstringrequired

The phase of the lifecycle that the job is currently in.

Allowed values:queuedin_progresscompleted

Example:queued

conclusionstringrequired

The outcome of the job.

Example:success

started_atstring(date-time)required

The time that the job started, in ISO 8601 format.

Example:2019-08-08T08:00:00-07:00

completed_atstring(date-time)required

The time that the job finished, in ISO 8601 format.

Example:2019-08-08T08:00:00-07:00

namestringrequired

The name of the job.

Example:test-coverage

stepsarray[object]

Steps in this job.

Show Child Parameters
check_run_urlstringrequired

Example:https://api.github.com/repos/github/hello-world/check-runs/4

Example

actions-enabled

boolean

Whether GitHub Actions is enabled on the repository.

actions-repository-permissions

object
enabledbooleanrequired

Whether GitHub Actions is enabled on the repository.

allowed_actionsstring

The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.

Allowed values:alllocal_onlyselected

selected_actions_urlstring

The API URL to use to get or set the actions that are allowed to run, when allowed_actions is set to selected.

Example

Pull Request Minimal

object
idintegerrequired
numberintegerrequired
urlstringrequired
headobjectrequired
Show Child Parameters
baseobjectrequired
Show Child Parameters
Example