per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
List self-hosted runners for a repository
Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.
get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/actions/runners
Query Parameters
Path Parameters
ownerstringrequired
repostringrequired
Response
200 application/json
Response
200 application/json
Response
total_countintegerrequired
runnersarray[object]required
A self hosted runner
Show Child Parameters
get/repos/{owner}/{repo}/actions/runners
Path Parameters
Query Parameters
200 application/json
List runner applications for a repository
Lists binaries for the runner application that you can download and run.
You must authenticate using an access token with the repo scope to use this endpoint.
get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/actions/runners/downloads
Path Parameters
ownerstringrequired
repostringrequired
Response
200 application/json
Response
200 application/json
Response
Runner Application
osstringrequired
architecturestringrequired
download_urlstringrequired
filenamestringrequired
temp_download_tokenstring
A short lived bearer token used to download the runner, if needed.
sha256_checksumstring
get/repos/{owner}/{repo}/actions/runners/downloads
Path Parameters
200 application/json
Create a registration token for a repository
Returns a token that you can pass to the config script. The token expires after one hour. You must authenticate
using an access token with the repo scope to use this endpoint.
Example using registration token
Configure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
post
http://HOSTNAME/api/v3/repos/{owner}/{repo}/actions/runners/registration-token
Path Parameters
ownerstringrequired
repostringrequired
Response
201 application/json
Response
201 application/json
Response
Authentication Token
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 | null
Example:config.yaml
repository_selectionstring
Describe whether all repositories have been selected or there’s a selection involved
Allowed values:allselected
post/repos/{owner}/{repo}/actions/runners/registration-token
Path Parameters
201 application/json
Create a remove token for a repository
Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.
You must authenticate using an access token with the repo scope to use this endpoint.
Example using remove token
To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
./config.sh remove --token TOKEN
post
http://HOSTNAME/api/v3/repos/{owner}/{repo}/actions/runners/remove-token
Path Parameters
ownerstringrequired
repostringrequired
Response
201 application/json
Response
201 application/json
Response
Authentication Token
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 | null
Example:config.yaml
repository_selectionstring
Describe whether all repositories have been selected or there’s a selection involved
Allowed values:allselected
post/repos/{owner}/{repo}/actions/runners/remove-token
Path Parameters
201 application/json
Get a self-hosted runner for a repository
Gets a specific self-hosted runner configured in a repository.
You must authenticate using an access token with the repo scope to use this
endpoint.
get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/actions/runners/{runner_id}
Path Parameters
ownerstringrequired
repostringrequired
runner_idintegerrequired
Unique identifier of the self-hosted runner.
Response
200 application/json
Response
200 application/json
Response
Self hosted runners
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
get/repos/{owner}/{repo}/actions/runners/{runner_id}
Path Parameters
200 application/json