self_hosted_runner_groups
Overview
| Name | self_hosted_runner_groups |
| Type | Resource |
| Id | github.actions.self_hosted_runner_groups |
Fields
| Name | Datatype | Description |
|---|---|---|
id | number | |
name | string | |
allows_public_repositories | boolean | |
inherited | boolean | |
runners_url | string | |
visibility | string | |
default | boolean | |
selected_repositories_url | string | Link to the selected repositories resource for this runner group. Not present unless visibility was set to selected |
inherited_allows_public_repositories | boolean |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get_self_hosted_runner_group_for_org | SELECT | org, runner_group_id | The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products." Gets a specific self-hosted runner group for an organization. You must authenticate using an access token with the admin:org scope to use this endpoint. |
list_self_hosted_runner_groups_for_org | SELECT | org | The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products." Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. You must authenticate using an access token with the admin:org scope to use this endpoint. |
create_self_hosted_runner_group_for_org | INSERT | org, data__name | The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "GitHub's products." Creates a new self-hosted runner group for an organization. You must authenticate using an access token with the admin:org scope to use this endpoint. |
delete_self_hosted_runner_group_from_org | DELETE | org, runner_group_id | The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products." Deletes a self-hosted runner group for an organization. You must authenticate using an access token with the admin:org scope to use this endpoint. |
update_self_hosted_runner_group_for_org | EXEC | org, runner_group_id, data__name | The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "GitHub's products." Updates the name and visibility of a self-hosted runner group in an organization.You must authenticate using an access token with the admin:org scope to use this endpoint. |