Get self-hosted runners settings for an organization

1 parameter

orgstringrequired

The organization name. The name is not case sensitive.

3 status codes

200Response

enabled_repositoriesstringrequired

The policy that controls whether self-hosted runners can be used by repositories in the organization

Allowed:allselectednone

selected_repositories_urlstringoptional

The URL to the endpoint for managing selected repositories for self-hosted runners in the organization

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found.

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.selfHostedRunners.list({ org: "acme-inc" });

{
  "enabled_repositories": "selected",
  "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories"
}

Request

Response

Errors