per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
List self-hosted runner groups for an organization
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.
get
http://HOSTNAME/api/v3/orgs/{org}/actions/runner-groups
Query Parameters
Path Parameters
orgstringrequired
Response
200 application/json
Response
200 application/json
Response
total_countnumberrequired
runner_groupsarray[object]required
Show Child Parameters
get/orgs/{org}/actions/runner-groups
Path Parameters
Query Parameters
200 application/json
Create a self-hosted runner group for an organization
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.
post
http://HOSTNAME/api/v3/orgs/{org}/actions/runner-groups
Path Parameters
orgstringrequired
Body
application/json
Body
application/json
namestringrequired
Name of the runner group.
visibilitystring
Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: all, selected, or private.
Allowed values:selectedallprivate
Default:all
selected_repository_idsarray[integer]
Unique identifier of the repository.
runnersarray[integer]
Unique identifier of the runner.
allows_public_repositoriesboolean
Whether the runner group can be used by public repositories.
Default:false
Response
201 application/json
Response
201 application/json
Response
runner-groups-org
idnumberrequired
namestringrequired
visibilitystringrequired
defaultbooleanrequired
selected_repositories_urlstring
Link to the selected repositories resource for this runner group. Not present unless visibility was set to selected
runners_urlstringrequired
inheritedbooleanrequired
inherited_allows_public_repositoriesboolean
allows_public_repositoriesbooleanrequired
post/orgs/{org}/actions/runner-groups
Path Parameters
Body
{
"name": "Expensive hardware runners",
"visibility": "selected",
"selected_repository_ids": [
32,
91
],
"runners": [
9,
2
]
}
201 application/json
Get a self-hosted runner group for an organization
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.
get
http://HOSTNAME/api/v3/orgs/{org}/actions/runner-groups/{runner_group_id}
Path Parameters
orgstringrequired
runner_group_idintegerrequired
Unique identifier of the self-hosted runner group.
Response
200 application/json
Response
200 application/json
Response
runner-groups-org
idnumberrequired
namestringrequired
visibilitystringrequired
defaultbooleanrequired
selected_repositories_urlstring
Link to the selected repositories resource for this runner group. Not present unless visibility was set to selected
runners_urlstringrequired
inheritedbooleanrequired
inherited_allows_public_repositoriesboolean
allows_public_repositoriesbooleanrequired
get/orgs/{org}/actions/runner-groups/{runner_group_id}
Path Parameters
200 application/json
Update a self-hosted runner group for an organization
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.
patch
http://HOSTNAME/api/v3/orgs/{org}/actions/runner-groups/{runner_group_id}
Path Parameters
orgstringrequired
runner_group_idintegerrequired
Unique identifier of the self-hosted runner group.
Body
application/json
Body
application/json
namestringrequired
Name of the runner group.
visibilitystring
Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: all, selected, or private.
Allowed values:selectedallprivate
allows_public_repositoriesboolean
Whether the runner group can be used by public repositories.
Default:false
Response
200 application/json
Response
200 application/json
Response
runner-groups-org
idnumberrequired
namestringrequired
visibilitystringrequired
defaultbooleanrequired
selected_repositories_urlstring
Link to the selected repositories resource for this runner group. Not present unless visibility was set to selected
runners_urlstringrequired
inheritedbooleanrequired
inherited_allows_public_repositoriesboolean
allows_public_repositoriesbooleanrequired
patch/orgs/{org}/actions/runner-groups/{runner_group_id}
Path Parameters
Body
{
"name": "Expensive hardware runners",
"visibility": "selected"
}
200 application/json
Delete a self-hosted runner group from an organization
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.
delete
http://HOSTNAME/api/v3/orgs/{org}/actions/runner-groups/{runner_group_id}
Path Parameters
orgstringrequired
runner_group_idintegerrequired
Unique identifier of the self-hosted runner group.
Response
204
Response
204
Response
delete/orgs/{org}/actions/runner-groups/{runner_group_id}
Path Parameters
204