Selbstgehostete Runnergruppen

Verwende die REST-API, um mit selbstgehosteten Runnergruppen für GitHub Actions zu interagieren.

Informationen zu selbstgehosteten Runnergruppen in GitHub Actions

Du kannst die REST-API verwenden, um Gruppen mit selbstgehosteten Runnern in GitHub Actions zu verwalten. Weitere Informationen findest du unter Verwalten des Zugriffs auf selbstgehostete Runner mithilfe von Gruppen.

Diese Endpunkte sind für authentifizierte Benutzer, OAuth Apps und GitHub Apps verfügbar. Zugriffstoken erfordern einen repo-Bereich für private Repositorys und einen public_repo-Bereich für interne Repositorys. GitHub Apps müssen über die administration-Berechtigung für Repositorys oder organization_self_hosted_runners-Berechtigungen für Organisationen verfügen. Authentifizierte Benutzer müssen über Administratorzugriff auf Repositorys oder Organisationen oder auf den Bereich manage_runners:enterprise für Unternehmen verfügen, um diese Endpunkte zu verwenden.

List self-hosted runner groups for an enterprise

Lists all self-hosted runner groups for an enterprise.

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

Parameter für „List self-hosted runner groups for an enterprise“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Abfrageparameter
Name, type, BESCHREIBUNG
`per_page` integer The number of results per page (max 100). Standard: `30`
`page` integer Page number of the results to fetch. Standard: `1`
`visible_to_organization` string Only return runner groups that are allowed to be used by this organization.

HTTP-Antwortstatuscodes für „List self-hosted runner groups for an enterprise“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „List self-hosted runner groups for an enterprise“

get/enterprises/{enterprise}/actions/runner-groups

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups

Response

Status: 200

{
  "total_count": 3,
  "runner_groups": [
    {
      "id": 1,
      "name": "Default",
      "visibility": "all",
      "default": true,
      "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners",
      "allows_public_repositories": false,
      "restricted_to_workflows": false,
      "selected_workflows": [],
      "workflow_restrictions_read_only": false
    },
    {
      "id": 2,
      "name": "octo-runner-group",
      "visibility": "selected",
      "default": false,
      "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations",
      "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners",
      "allows_public_repositories": true,
      "restricted_to_workflows": true,
      "selected_workflows": [
        "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
      ],
      "workflow_restrictions_read_only": false
    },
    {
      "id": 3,
      "name": "expensive-hardware",
      "visibility": "private",
      "default": false,
      "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners",
      "allows_public_repositories": true,
      "restricted_to_workflows": false,
      "selected_workflows": [
        "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
      ],
      "workflow_restrictions_read_only": false
    }
  ]
}

Create a self-hosted runner group for an enterprise

Creates a new self-hosted runner group for an enterprise.

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

Parameter für „Create a self-hosted runner group for an enterprise“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name. You can also substitute this value with the enterprise id.
Textparameter
Name, type, BESCHREIBUNG
`name` string Erforderlich Name of the runner group.
`visibility` string Visibility of a runner group. You can select all organizations or select individual organization. Kann eine der Folgenden sein: `selected`, `all`
`selected_organization_ids` array of integers List of organization IDs that can access the runner group.
`runners` array of integers List of runner IDs to add to the runner group.
`allows_public_repositories` boolean Whether the runner group can be used by `public` repositories. Standard: `false`

HTTP-Antwortstatuscodes für „Create a self-hosted runner group for an enterprise“

Statuscode	BESCHREIBUNG
`201`	Created

Codebeispiele für „Create a self-hosted runner group for an enterprise“

post/enterprises/{enterprise}/actions/runner-groups

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups \
  -d '{"name":"Expensive hardware runners","visibility":"selected","selected_organization_ids":[32,91],"runners":[9,2]}'

Response

Status: 201

{
  "id": 2,
  "name": "octo-runner-group",
  "visibility": "selected",
  "default": false,
  "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations",
  "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners",
  "allows_public_repositories": false,
  "restricted_to_workflows": true,
  "selected_workflows": [
    "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
  ],
  "workflow_restrictions_read_only": false
}

Get a self-hosted runner group for an enterprise

Gets a specific self-hosted runner group for an enterprise.

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

Parameter für „Get a self-hosted runner group for an enterprise“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name. You can also substitute this value with the enterprise id.
`runner_group_id` integer Erforderlich Unique identifier of the self-hosted runner group.

HTTP-Antwortstatuscodes für „Get a self-hosted runner group for an enterprise“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „Get a self-hosted runner group for an enterprise“

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups/RUNNER_GROUP_ID

Response

Status: 200

{
  "id": 2,
  "name": "octo-runner-group",
  "visibility": "selected",
  "default": false,
  "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations",
  "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners",
  "allows_public_repositories": false,
  "restricted_to_workflows": true,
  "selected_workflows": [
    "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
  ],
  "workflow_restrictions_read_only": false
}

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.

Parameter für „Update a self-hosted runner group for an enterprise“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name. You can also substitute this value with the enterprise id.
`runner_group_id` integer Erforderlich Unique identifier of the self-hosted runner group.
Textparameter
Name, type, BESCHREIBUNG
`name` string Name of the runner group.
`visibility` string Visibility of a runner group. You can select all organizations or select individual organizations. Standard: `all` Kann eine der Folgenden sein: `selected`, `all`
`allows_public_repositories` boolean Whether the runner group can be used by `public` repositories. Standard: `false`

HTTP-Antwortstatuscodes für „Update a self-hosted runner group for an enterprise“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „Update a self-hosted runner group for an enterprise“

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

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups/RUNNER_GROUP_ID \
  -d '{"name":"Expensive hardware runners","visibility":"selected"}'

Response

Status: 200

{
  "id": 2,
  "name": "Expensive hardware runners",
  "visibility": "selected",
  "default": false,
  "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations",
  "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners",
  "allows_public_repositories": true,
  "restricted_to_workflows": false,
  "selected_workflows": [
    "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
  ],
  "workflow_restrictions_read_only": false
}

Delete a self-hosted runner group from an enterprise

Deletes a self-hosted runner group for an enterprise.

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

Parameter für „Delete a self-hosted runner group from an enterprise“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name. You can also substitute this value with the enterprise id.
`runner_group_id` integer Erforderlich Unique identifier of the self-hosted runner group.

HTTP-Antwortstatuscodes für „Delete a self-hosted runner group from an enterprise“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Delete a self-hosted runner group from an enterprise“

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

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups/RUNNER_GROUP_ID

Response

Status: 204

List self-hosted runners in a group for an enterprise

Lists the self-hosted runners that are in a specific enterprise group.

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

Parameter für „List self-hosted runners in a group for an enterprise“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name. You can also substitute this value with the enterprise id.
`runner_group_id` integer Erforderlich Unique identifier of the self-hosted runner group.
Abfrageparameter
Name, type, BESCHREIBUNG
`per_page` integer The number of results per page (max 100). Standard: `30`
`page` integer Page number of the results to fetch. Standard: `1`

HTTP-Antwortstatuscodes für „List self-hosted runners in a group for an enterprise“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „List self-hosted runners in a group for an enterprise“

get/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups/RUNNER_GROUP_ID/runners

Response

Status: 200

{
  "total_count": 2,
  "runners": [
    {
      "id": 23,
      "name": "linux_runner",
      "os": "linux",
      "status": "online",
      "busy": true,
      "labels": [
        {
          "id": 5,
          "name": "self-hosted",
          "type": "read-only"
        },
        {
          "id": 7,
          "name": "X64",
          "type": "read-only"
        },
        {
          "id": 11,
          "name": "Linux",
          "type": "read-only"
        }
      ]
    },
    {
      "id": 24,
      "name": "mac_runner",
      "os": "macos",
      "status": "offline",
      "busy": false,
      "labels": [
        {
          "id": 5,
          "name": "self-hosted",
          "type": "read-only"
        },
        {
          "id": 7,
          "name": "X64",
          "type": "read-only"
        },
        {
          "id": 20,
          "name": "macOS",
          "type": "read-only"
        },
        {
          "id": 21,
          "name": "no-gpu",
          "type": "custom"
        }
      ]
    }
  ]
}

Set self-hosted runners in a group for an enterprise

Replaces the list of self-hosted runners that are part of an enterprise runner group.

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

Parameter für „Set self-hosted runners in a group for an enterprise“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name. You can also substitute this value with the enterprise id.
`runner_group_id` integer Erforderlich Unique identifier of the self-hosted runner group.
Textparameter
Name, type, BESCHREIBUNG
`runners` array of integers Erforderlich List of runner IDs to add to the runner group.

HTTP-Antwortstatuscodes für „Set self-hosted runners in a group for an enterprise“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Set self-hosted runners in a group for an enterprise“

put/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups/RUNNER_GROUP_ID/runners \
  -d '{"runners":[9,2]}'

Response

Status: 204

Add a self-hosted runner to a group for an enterprise

Adds a self-hosted runner to a runner group configured in an enterprise.

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

Parameter für „Add a self-hosted runner to a group for an enterprise“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name. You can also substitute this value with the enterprise id.
`runner_group_id` integer Erforderlich Unique identifier of the self-hosted runner group.
`runner_id` integer Erforderlich Unique identifier of the self-hosted runner.

HTTP-Antwortstatuscodes für „Add a self-hosted runner to a group for an enterprise“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Add a self-hosted runner to a group for an enterprise“

put/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups/RUNNER_GROUP_ID/runners/RUNNER_ID

Response

Status: 204

Remove a self-hosted runner from a group for an enterprise

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

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

Parameter für „Remove a self-hosted runner from a group for an enterprise“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`enterprise` string Erforderlich The slug version of the enterprise name. You can also substitute this value with the enterprise id.
`runner_group_id` integer Erforderlich Unique identifier of the self-hosted runner group.
`runner_id` integer Erforderlich Unique identifier of the self-hosted runner.

HTTP-Antwortstatuscodes für „Remove a self-hosted runner from a group for an enterprise“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Remove a self-hosted runner from a group for an enterprise“

delete/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/enterprises/ENTERPRISE/actions/runner-groups/RUNNER_GROUP_ID/runners/RUNNER_ID

Response

Status: 204

List self-hosted runner groups for an organization

Funktioniert mit GitHub Apps

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.

Parameter für „List self-hosted runner groups for an organization“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
Abfrageparameter
Name, type, BESCHREIBUNG
`per_page` integer The number of results per page (max 100). Standard: `30`
`page` integer Page number of the results to fetch. Standard: `1`

HTTP-Antwortstatuscodes für „List self-hosted runner groups for an organization“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „List self-hosted runner groups for an organization“

get/orgs/{org}/actions/runner-groups

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/orgs/ORG/actions/runner-groups

Response

Status: 200

{
  "total_count": 3,
  "runner_groups": [
    {
      "id": 1,
      "name": "Default",
      "visibility": "all",
      "default": true,
      "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners",
      "inherited": false,
      "allows_public_repositories": true,
      "restricted_to_workflows": false,
      "selected_workflows": [],
      "workflow_restrictions_read_only": false
    },
    {
      "id": 2,
      "name": "octo-runner-group",
      "visibility": "selected",
      "default": false,
      "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories",
      "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners",
      "inherited": true,
      "allows_public_repositories": true,
      "restricted_to_workflows": true,
      "selected_workflows": [
        "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
      ],
      "workflow_restrictions_read_only": true
    },
    {
      "id": 3,
      "name": "expensive-hardware",
      "visibility": "private",
      "default": false,
      "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners",
      "inherited": false,
      "allows_public_repositories": true,
      "restricted_to_workflows": false,
      "selected_workflows": [
        "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
      ],
      "workflow_restrictions_read_only": false
    }
  ]
}

Create a self-hosted runner group for an organization

Funktioniert mit GitHub Apps

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.

Parameter für „Create a self-hosted runner group for an organization“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
Textparameter
Name, type, BESCHREIBUNG
`name` string Erforderlich Name of the runner group.
`visibility` string Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Standard: `all` Kann eine der Folgenden sein: `selected`, `all`, `private`
`selected_repository_ids` array of integers List of repository IDs that can access the runner group.
`runners` array of integers List of runner IDs to add to the runner group.
`allows_public_repositories` boolean Whether the runner group can be used by `public` repositories. Standard: `false`
`restricted_to_workflows` boolean If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. Standard: `false`
`selected_workflows` array of strings List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.

HTTP-Antwortstatuscodes für „Create a self-hosted runner group for an organization“

Statuscode	BESCHREIBUNG
`201`	Created

Codebeispiele für „Create a self-hosted runner group for an organization“

post/orgs/{org}/actions/runner-groups

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/orgs/ORG/actions/runner-groups \
  -d '{"name":"Expensive hardware runners","visibility":"selected","selected_repository_ids":[32,91],"runners":[9,2]}'

Response

Status: 201

{
  "id": 2,
  "name": "octo-runner-group",
  "visibility": "selected",
  "default": false,
  "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories",
  "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners",
  "inherited": false,
  "allows_public_repositories": true,
  "restricted_to_workflows": true,
  "selected_workflows": [
    "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
  ],
  "workflow_restrictions_read_only": false
}

Get a self-hosted runner group for an organization

Funktioniert mit GitHub Apps

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.

Parameter für „Get a self-hosted runner group for an organization“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`runner_group_id` integer Erforderlich Unique identifier of the self-hosted runner group.

HTTP-Antwortstatuscodes für „Get a self-hosted runner group for an organization“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „Get a self-hosted runner group for an organization“

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID

Response

Status: 200

{
  "id": 2,
  "name": "octo-runner-group",
  "visibility": "selected",
  "default": false,
  "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories",
  "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners",
  "inherited": false,
  "allows_public_repositories": true,
  "restricted_to_workflows": true,
  "selected_workflows": [
    "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
  ],
  "workflow_restrictions_read_only": false
}

Update a self-hosted runner group for an organization

Funktioniert mit GitHub Apps

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.

Parameter für „Update a self-hosted runner group for an organization“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`runner_group_id` integer Erforderlich Unique identifier of the self-hosted runner group.
Textparameter
Name, type, BESCHREIBUNG
`name` string Erforderlich Name of the runner group.
`visibility` string Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Kann eine der Folgenden sein: `selected`, `all`, `private`
`allows_public_repositories` boolean Whether the runner group can be used by `public` repositories. Standard: `false`
`restricted_to_workflows` boolean If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. Standard: `false`
`selected_workflows` array of strings List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.

HTTP-Antwortstatuscodes für „Update a self-hosted runner group for an organization“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „Update a self-hosted runner group for an organization“

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

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID \
  -d '{"name":"Expensive hardware runners","visibility":"selected"}'

Response

Status: 200

{
  "id": 2,
  "name": "octo-runner-group",
  "visibility": "selected",
  "default": false,
  "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories",
  "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners",
  "inherited": false,
  "allows_public_repositories": true,
  "restricted_to_workflows": true,
  "selected_workflows": [
    "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main"
  ],
  "workflow_restrictions_read_only": false
}

Delete a self-hosted runner group from an organization

Funktioniert mit GitHub Apps

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.

Parameter für „Delete a self-hosted runner group from an organization“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`runner_group_id` integer Erforderlich Unique identifier of the self-hosted runner group.

HTTP-Antwortstatuscodes für „Delete a self-hosted runner group from an organization“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Delete a self-hosted runner group from an organization“

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

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID

Response

Status: 204

Add a self-hosted runner to a group for an organization

Funktioniert mit GitHub Apps

Adds a self-hosted runner to a runner group configured in an organization.

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

Parameter für „Add a self-hosted runner to a group for an organization“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`runner_group_id` integer Erforderlich Unique identifier of the self-hosted runner group.
`runner_id` integer Erforderlich Unique identifier of the self-hosted runner.

HTTP-Antwortstatuscodes für „Add a self-hosted runner to a group for an organization“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Add a self-hosted runner to a group for an organization“

put/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID/runners/RUNNER_ID

Response

Status: 204