self_hosted_runners

Overview

Name	self_hosted_runners
Type	Resource
Id	github.enterprise_admin.self_hosted_runners

Fields

Name	Datatype	Description
id	integer	The id of the runner.
name	string	The name of the runner.
labels	array
os	string	The Operating System of the runner.
status	string	The status of the runner.
busy	boolean

Methods

Name	Accessible by	Required Params	Description
get_self_hosted_runner_for_enterprise	SELECT	enterprise, runner_id	Gets a specific self-hosted runner configured in an enterprise. You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
list_self_hosted_runners_for_enterprise	SELECT	enterprise	Lists all self-hosted runners configured for an enterprise. You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
list_self_hosted_runners_in_group_for_enterprise	SELECT	enterprise, runner_group_id	Lists the self-hosted runners that are in a specific enterprise group. You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
add_self_hosted_runner_to_group_for_enterprise	INSERT	enterprise, runner_group_id, runner_id	Adds a self-hosted runner to a runner group configured in an enterprise. You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
delete_self_hosted_runner_from_enterprise	DELETE	enterprise, runner_id	Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
remove_self_hosted_runner_from_group_for_enterprise	DELETE	enterprise, runner_group_id, runner_id	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 manage_runners:enterprise scope to use this endpoint.
create_registration_token_for_enterprise	EXEC	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 manage_runners: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. <br />./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN<br />
create_remove_token_for_enterprise	EXEC	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 manage_runners: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. <br />./config.sh remove --token TOKEN<br />
set_self_hosted_runners_in_group_for_enterprise	EXEC	enterprise, runner_group_id, data__runners	Replaces the list of self-hosted runners that are part of an enterprise runner group. You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.