Skip to content
forgit api docs

Set self-hosted runners settings for an organization

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

Sets 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

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

The organization name. The name is not case sensitive.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
enabled_repositories
required

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

string
Allowed values: all selected none
Examples
Exampleapplication/json
{
  "enabled_repositories": "all"
}

Responses

Section titled “Responses”

204

Section titled “204”

No content

403

Section titled “403”

Forbidden

Media typeapplication/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Section titled “404”

Resource not found

Media typeapplication/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Section titled “422”

Validation failed, or the endpoint has been spammed.

Media typeapplication/json
Validation Error

Validation Error

object
message
required
string
documentation_url
required
string
errors
Array<object>
object
resource
string
field
string
message
string
code
required
string
index
integer
value
One of:
string
nullable
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}