org_runner_group_runners

Creates, updates, deletes, gets or lists an org_runner_group_runners resource.

Overview

Name	org_runner_group_runners
Type	Resource
Id	github.actions.org_runner_group_runners

Fields

The following fields are returned by SELECT queries:

list_self_hosted_runners_in_group_for_org

Response

Name	Datatype	Description
runners	array
total_count	number

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_self_hosted_runners_in_group_for_org	select	org, runner_group_id	per_page, page	Lists self-hosted runners that are in a specific organization group. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
add_self_hosted_runner_to_group_for_org	replace	org, runner_group_id, runner_id		Adds a self-hosted runner to a runner group configured in an organization. OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
set_self_hosted_runners_in_group_for_org	replace	org, runner_group_id, runners		Replaces the list of self-hosted runners that are part of an organization runner group. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
remove_self_hosted_runner_from_group_for_org	delete	org, runner_group_id, runner_id		Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
org	string	The organization name. The name is not case sensitive.
runner_group_id	integer	Unique identifier of the self-hosted runner group.
runner_id	integer	Unique identifier of the self-hosted runner.
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

list_self_hosted_runners_in_group_for_org

Lists self-hosted runners that are in a specific organization group.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

SELECT
runners,
total_count
FROM github.actions.org_runner_group_runners
WHERE org = '{{ org }}' -- required
AND runner_group_id = '{{ runner_group_id }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;

REPLACE examples

add_self_hosted_runner_to_group_for_org

Adds a self-hosted runner to a runner group configured in an organization.

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

REPLACE github.actions.org_runner_group_runners
SET 
-- No updatable properties
WHERE 
org = '{{ org }}' --required
AND runner_group_id = '{{ runner_group_id }}' --required
AND runner_id = '{{ runner_id }}' --required;

set_self_hosted_runners_in_group_for_org

Replaces the list of self-hosted runners that are part of an organization runner group.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

REPLACE github.actions.org_runner_group_runners
SET 
runners = '{{ runners }}'
WHERE 
org = '{{ org }}' --required
AND runner_group_id = '{{ runner_group_id }}' --required
AND runners = '{{ runners }}' --required;

DELETE examples

remove_self_hosted_runner_from_group_for_org

Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

DELETE FROM github.actions.org_runner_group_runners
WHERE org = '{{ org }}' --required
AND runner_group_id = '{{ runner_group_id }}' --required
AND runner_id = '{{ runner_id }}' --required
;