per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
List self-hosted runners for an enterprise
Lists all self-hosted runners configured for an enterprise.
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
get
{protocol}://{hostname}/api/v3/enterprises/{enterprise}/actions/runners
Query Parameters
Path Parameters
enterprisestringrequired
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Response
200 application/json
Response
200 application/json
Response
total_countnumber
runnersarray[object]
A self hosted runner
Show Child Parameters
get/enterprises/{enterprise}/actions/runners
Path Parameters
Query Parameters
200 application/json
List runner applications for an enterprise
Lists binaries for the runner application that you can download and run.
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
get
{protocol}://{hostname}/api/v3/enterprises/{enterprise}/actions/runners/downloads
Path Parameters
enterprisestringrequired
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
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/enterprises/{enterprise}/actions/runners/downloads
Path Parameters
200 application/json
Create a registration token for an enterprise
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 admin:enterprise 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/enterprises/octo-enterprise --token TOKEN
post
{protocol}://{hostname}/api/v3/enterprises/{enterprise}/actions/runners/registration-token
Path Parameters
enterprisestringrequired
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
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/enterprises/{enterprise}/actions/runners/registration-token
Path Parameters
201 application/json
Create a remove token for an enterprise
Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Example using remove token
To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this
endpoint.
./config.sh remove --token TOKEN
post
{protocol}://{hostname}/api/v3/enterprises/{enterprise}/actions/runners/remove-token
Path Parameters
enterprisestringrequired
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
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/enterprises/{enterprise}/actions/runners/remove-token
Path Parameters
201 application/json
Get a self-hosted runner for an enterprise
Gets a specific self-hosted runner configured in an enterprise.
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
get
{protocol}://{hostname}/api/v3/enterprises/{enterprise}/actions/runners/{runner_id}
Path Parameters
enterprisestringrequired
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
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/enterprises/{enterprise}/actions/runners/{runner_id}
Path Parameters
200 application/json