Skip to main content

org_self_hosted_runners_permissions

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

Overview​

Nameorg_self_hosted_runners_permissions
TypeResource
Idgithub.actions.org_self_hosted_runners_permissions

Fields​

The following fields are returned by SELECT queries:

Response

NameDatatypeDescription
enabled_repositoriesstringThe policy that controls whether self-hosted runners can be used by repositories in the organization (all, selected, none)
selected_repositories_urlstringThe URL to the endpoint for managing selected repositories for self-hosted runners in the organization

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_self_hosted_runners_permissions_organizationselectorgGets the settings for self-hosted runners for an organization.

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the "Actions policies" fine-grained permission to use this endpoint.
set_self_hosted_runners_permissions_organizationreplaceorg, enabled_repositoriesSets the settings for self-hosted runners for an organization.

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the "Actions policies" fine-grained permission 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.

SELECT examples​

Gets the settings for self-hosted runners for an organization.

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the "Actions policies" fine-grained permission to use this endpoint.

SELECT
enabled_repositories,
selected_repositories_url
FROM github.actions.org_self_hosted_runners_permissions
WHERE org = '{{ org }}' -- required
;

REPLACE examples​

Sets the settings for self-hosted runners for an organization.

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the "Actions policies" fine-grained permission to use this endpoint.

REPLACE github.actions.org_self_hosted_runners_permissions
SET
enabled_repositories = '{{ enabled_repositories }}'
WHERE
org = '{{ org }}' --required
AND enabled_repositories = '{{ enabled_repositories }}' --required;