Skip to main content

org_runner_group_hosted_runners

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

Overview

Nameorg_runner_group_hosted_runners
TypeResource
Idgithub.actions.org_runner_group_hosted_runners

Fields

The following fields are returned by SELECT queries:

Response

NameDatatypeDescription
runnersarray
total_countnumber

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_github_hosted_runners_in_group_for_orgselectorg, runner_group_idper_page, pageLists 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.

NameDatatypeDescription
orgstringThe organization name. The name is not case sensitive.
runner_group_idintegerUnique identifier of the self-hosted runner group.
pageintegerThe page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_pageintegerThe number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

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
runners,
total_count
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 }}'
;