org_runner_group_hosted_runners

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

Overview

Name	org_runner_group_hosted_runners
Type	Resource
Id	github.actions.org_runner_group_hosted_runners

Fields

The following fields are returned by SELECT queries:

list_github_hosted_runners_in_group_for_org

Response

Name	Datatype	Description
id	integer	The unique identifier of the hosted runner.
name	string	The name of the hosted runner. (example: my-github-hosted-runner)
runner_group_id	integer	The unique identifier of the group that the hosted runner belongs to.
image_details	object	Provides details of a hosted runner image (title: GitHub-hosted runner image details.)
image_gen	boolean	Whether custom image generation is enabled for the hosted runners.
last_active_on	string (date-time)	The time at which the runner was last used, in ISO 8601 format. (example: 2022-10-09T23:39:01Z)
machine_size_details	object	Provides details of a particular machine spec. (title: Github-owned VM details.)
maximum_runners	integer	The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.
platform	string	The operating system of the image. (example: linux-x64)
public_ip_enabled	boolean	Whether public IP is enabled for the hosted runners.
public_ips	array	The public IP ranges when public IP is enabled for the hosted runners.
status	string	The status of the runner. (Ready, Provisioning, Shutdown, Deleting, Stuck) (example: Ready)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_github_hosted_runners_in_group_for_org	select	org, runner_group_id	per_page, page	Lists the GitHub-hosted runners in an organization 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.
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_github_hosted_runners_in_group_for_org

Lists the GitHub-hosted runners in an organization group.

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

SELECT
id,
name,
runner_group_id,
image_details,
image_gen,
last_active_on,
machine_size_details,
maximum_runners,
platform,
public_ip_enabled,
public_ips,
status
FROM github.actions.org_runner_group_hosted_runners
WHERE org = '{{ org }}' -- required
AND runner_group_id = '{{ runner_group_id }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;