Create a self-hosted runner group for an organization

1 parameter · 8 body fields

orgstringrequired

The organization name. The name is not case sensitive.

namestringrequired

Name of the runner group.

visibilitystringoptional

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

Allowed:selectedallprivateDefault:all

selected_repository_idsarray<integer>optional

List of repository IDs that can access the runner group.

runnersarray<integer>optional

List of runner IDs to add to the runner group.

allows_public_repositoriesbooleanoptional

Whether the runner group can be used by `public` repositories.

Default:false

restricted_to_workflowsbooleanoptional

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

Default:false

selected_workflowsarray<string>optional

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

network_configuration_idstringoptional

The identifier of a hosted compute network configuration.

1 status code

201Response

idnumberrequired

namestringrequired

visibilitystringrequired

defaultbooleanrequired

selected_repositories_urlstringoptional

Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`

runners_urlstringrequired

hosted_runners_urlstringoptional

network_configuration_idstringoptional

The identifier of a hosted compute network configuration.

inheritedbooleanrequired

inherited_allows_public_repositoriesbooleanoptional

allows_public_repositoriesbooleanrequired

workflow_restrictions_read_onlybooleanoptional

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

Default:false

restricted_to_workflowsbooleanoptional

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

Default:false

selected_workflowsarray<string>optional

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

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.runnerGroups.create({
  org: "acme-inc",
  name: "Untitled",
  visibility: "example",
  selectedRepositoryIds: "hello-world",
  runners: [],
});

{
  "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",
  "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners",
  "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA",
  "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
}

Request

Response