PATCH /orgs/{org}/actions/runner-groups/{runner_group_id}

Updates the name and visibility of a self-hosted runner group in an organization.

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

Servers

Path parameters

Name Type Required Description
org String Yes

The organization name. The name is not case sensitive.

runner_group_id Integer Yes

Unique identifier of the self-hosted runner group.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
visibility String No

Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.

Possible values:

  • "private"
  • "selected"
  • "all"
selected_workflows[] Array No

List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

name String Yes

Name of the runner group.

allows_public_repositories Boolean No

Whether the runner group can be used by public repositories.

Default value: false

restricted_to_workflows Boolean No

If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.

Default value: false

network_configuration_id String No

The identifier of a hosted compute network configuration.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.