Search
K
Internal DocumentHub admin Api very long name and description

Pull Request Minimal

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

Simple Commit

object

Simple Commit

idstringrequired
tree_idstringrequired
messagestringrequired
timestampstring(date-time)required
authorobjectrequired
Show Child Parameters
committerobjectrequired
Show Child Parameters
Example

Workflow Run

object

An invocation of a workflow

idintegerrequired

The ID of the workflow run.

Example:5

namestring

The name of the workflow run.

Example:Build

node_idstringrequired

Example:MDEwOkNoZWNrU3VpdGU1

check_suite_idinteger

The ID of the associated check suite.

Example:42

check_suite_node_idstring

The node ID of the associated check suite.

Example:MDEwOkNoZWNrU3VpdGU0Mg==

head_branchstringrequired

Example:master

head_shastringrequired

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

Example:009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

run_numberintegerrequired

The auto incrementing run number for the workflow run.

Example:106

run_attemptinteger

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

Example:1

eventstringrequired

Example:push

statusstringrequired

Example:completed

conclusionstringrequired

Example:neutral

workflow_idintegerrequired

The ID of the parent workflow.

Example:5

urlstringrequired

The URL to the workflow run.

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

html_urlstringrequired

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

pull_requestsarray[object]required
Show Child Parameters
created_atstring(date-time)required
updated_atstring(date-time)required
run_started_atstring(date-time)

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

jobs_urlstringrequired

The URL to the jobs for the workflow run.

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

logs_urlstringrequired

The URL to download the logs for the workflow run.

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

check_suite_urlstringrequired

The URL to the associated check suite.

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

artifacts_urlstringrequired

The URL to the artifacts for the workflow run.

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

cancel_urlstringrequired

The URL to cancel the workflow run.

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

rerun_urlstringrequired

The URL to rerun the workflow run.

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

previous_attempt_urlstring

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

workflow_urlstringrequired

The URL to the workflow.

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

head_commitobjectrequired

Simple Commit

Show Child Parameters
repositoryobjectrequired

Minimal Repository

Show Child Parameters
head_repositoryobjectrequired

Minimal Repository

Show Child Parameters
head_repository_idinteger

Example:5

Example

Actions Secret

object

Set secrets for GitHub Actions.

namestringrequired

The name of the secret.

Example:SECRET_TOKEN

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

Workflow

object

A GitHub Actions workflow

idintegerrequired

Example:5

node_idstringrequired

Example:MDg6V29ya2Zsb3cxMg==

namestringrequired

Example:CI

pathstringrequired

Example:ruby.yaml

statestringrequired

Allowed values:activedeleteddisabled_forkdisabled_inactivitydisabled_manually

Example:active

created_atstring(date-time)required

Example:2019-12-06T14:20:20.000Z

updated_atstring(date-time)required

Example:2019-12-06T14:20:20.000Z

urlstringrequired

Example:https://api.github.com/repos/actions/setup-ruby/workflows/5

html_urlstringrequired

Example:https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml

badge_urlstringrequired

Example:https://github.com/actions/setup-ruby/workflows/CI/badge.svg

deleted_atstring(date-time)

Example:2019-12-06T14:20:20.000Z

Example