GitHub v3 REST API

Self hosted runners

object

A self hosted runner

idintegerrequired

The id of the runner.

Example:5

namestringrequired

The name of the runner.

Example:iMac

osstringrequired

The Operating System of the runner.

Example:macos

statusstringrequired

The status of the runner.

Example:online

busybooleanrequired
labelsarray[object]required

A label for a self hosted runner

Show Child Parameters
Example

Runner Application

object

Runner Application

osstringrequired
architecturestringrequired
download_urlstringrequired
filenamestringrequired
temp_download_tokenstring

A short lived bearer token used to download the runner, if needed.

sha256_checksumstring
Example

Authentication Token

object

Authentication Token

tokenstringrequired

The token used for authentication

Example:v1.1f699f1069f60xxx

expires_atstring(date-time)required

The time this token expires

Example:2016-07-11T22:14:10Z

permissionsobject

Example:{"issues":"read","deployments":"write"}

repositoriesarray[object]

A git repository

Show Child Parameters
single_filestring

Example:config.yaml

repository_selectionstring

Describe whether all repositories have been selected or there’s a selection involved

Allowed values:allselected

Example

Actor

object

Actor

idintegerrequired
loginstringrequired
display_loginstring
gravatar_idstringrequired
urlstring(uri)required
avatar_urlstring(uri)required
Example

Milestone

object

A collection of related issues and pull requests.

urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/milestones/1

html_urlstring(uri)required

Example:https://github.com/octocat/Hello-World/milestones/v1.0

labels_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/milestones/1/labels

idintegerrequired

Example:1002604

node_idstringrequired

Example:MDk6TWlsZXN0b25lMTAwMjYwNA==

numberintegerrequired

The number of the milestone.

Example:42

statestringrequired

The state of the milestone.

Allowed values:openclosed

Default:open

Example:open

titlestringrequired

The title of the milestone.

Example:v1.0

descriptionstringrequired

Example:Tracking milestone for version 1.0

creatorobjectrequired

Simple User

Show Child Parameters
open_issuesintegerrequired

Example:4

closed_issuesintegerrequired

Example:8

created_atstring(date-time)required

Example:2011-04-10T20:09:31Z

updated_atstring(date-time)required

Example:2014-03-03T18:58:10Z

closed_atstring(date-time)required

Example:2013-02-12T13:22:01Z

due_onstring(date-time)required

Example:2012-10-09T23:39:01Z

Example