org_runner_group_repos

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

Overview

Name	org_runner_group_repos
Type	Resource
Id	github.actions.org_runner_group_repos

Fields

The following fields are returned by SELECT queries:

list_repo_access_to_self_hosted_runner_group_in_org

Response

Name	Datatype	Description
repositories	array
total_count	number

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_repo_access_to_self_hosted_runner_group_in_org	select	org, runner_group_id	page, per_page	Lists the repositories with access to a self-hosted runner group configured in an organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
add_repo_access_to_self_hosted_runner_group_in_org	replace	org, runner_group_id, repository_id		Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see "Create a self-hosted runner group for an organization." OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
set_repo_access_to_self_hosted_runner_group_in_org	replace	org, runner_group_id, selected_repository_ids		Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
remove_repo_access_to_self_hosted_runner_group_in_org	delete	org, runner_group_id, repository_id		Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see "Create a self-hosted runner group for an organization." 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.
repository_id	integer	The unique identifier of the repository.
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_repo_access_to_self_hosted_runner_group_in_org

Lists the repositories with access to a self-hosted runner group configured in an organization.

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

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

REPLACE examples

add_repo_access_to_self_hosted_runner_group_in_org

Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see "Create a self-hosted runner group for an organization."

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

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

set_repo_access_to_self_hosted_runner_group_in_org

Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

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

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

DELETE examples

remove_repo_access_to_self_hosted_runner_group_in_org

Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see "Create a self-hosted runner group for an organization."

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

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