The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Unique identifier of the self-hosted runner group.
Unique identifier of the self-hosted runner.
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Unique identifier of the self-hosted runner group.
Unique identifier of the self-hosted runner.
Response
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.
Results per page (max 100)
Default:30
Page number of the results to fetch.
Default:1
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Response
A self hosted runner
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.
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Response
Runner Application
A short lived bearer token used to download the runner, if needed.
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.
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
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Response
Authentication Token
The token used for authentication
Example:v1.1f699f1069f60xxx
The time this token expires
Example:2016-07-11T22:14:10Z
Example:{"issues":"read","deployments":"write"}
A git repository
Example:config.yaml
Describe whether all repositories have been selected or there’s a selection involved
Allowed values:allselected
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.
To remove your self-hosted runner from an enterprise, replace TOKEN
with the remove token provided by this
endpoint.
./config.sh remove --token TOKEN
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Response
Authentication Token
The token used for authentication
Example:v1.1f699f1069f60xxx
The time this token expires
Example:2016-07-11T22:14:10Z
Example:{"issues":"read","deployments":"write"}
A git repository
Example:config.yaml
Describe whether all repositories have been selected or there’s a selection involved
Allowed values:allselected