v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-07-147873273.9 MB

enterprise-admin

Update a self-hosted runner group for an enterprise

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

You must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.

patch/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}

enterprisestring required

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

runner_group_idinteger required

Unique identifier of the self-hosted runner group.

namestring

Name of the runner group.

visibility'selected' | 'all'

Visibility of a runner group. You can select all organizations or select individual organizations.

allows_public_repositoriesboolean

Whether the runner group can be used by public repositories.

restricted_to_workflowsboolean

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

selected_workflowsstring[]

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

{
  "selected_workflows": [
    "octo-org/octo-repo/.github/workflows/deploy.yaml@main"
  ]
}

idnumber required

namestring required

visibilitystring required

defaultboolean required

selected_organizations_urlstring

runners_urlstring required

allows_public_repositoriesboolean required

workflow_restrictions_read_onlyboolean

If true, the restricted_to_workflows and selected_workflows fields cannot be modified.

restricted_to_workflowsboolean

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

selected_workflowsstring[]

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

{
  "selected_workflows": [
    "octo-org/octo-repo/.github/workflows/deploy.yaml@main"
  ]
}