Get self-hosted runners settings for an organization

GET

/orgs/{org}/actions/permissions/self-hosted-runners

Gets the settings for self-hosted runners for an organization.

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the “Actions policies” fine-grained permission to use this endpoint.

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

Responses

200

Response

Media type application/json

object

enabled_repositories

required

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

string

Allowed values: all selected none

selected_repositories_url

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

string

Examples

Example response

Example response

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

403

Forbidden

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}