Skip to content
forgit api docs

Set custom labels for a self-hosted runner for an organization

PUT
/orgs/{org}/actions/runners/{runner_id}/labels

Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

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.

runner_id
required
integer

Unique identifier of the self-hosted runner.

Request Bodyrequired

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

The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.

Array<string>
0 <= 100 items
Examples
Exampledefault
{
  "labels": [
    "gpu",
    "accelerated"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Response

Media typeapplication/json
object
total_count
required
integer
labels
required
Array<object>
Self hosted runner label

A label for a self hosted runner

object
id

Unique identifier of the label.

integer
name
required

Name of the label.

string
type

The type of label. Read-only labels are applied automatically when the runner is configured.

string
Allowed values: read-only custom
Examples
Exampledefault
{
  "total_count": 4,
  "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"
    }
  ]
}

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"
}

422

Section titled “422”

Validation failed, or the endpoint has been spammed.

Media typeapplication/json
Validation Error Simple

Validation Error Simple

object
message
required
string
documentation_url
required
string
errors
Array<string>
Examplegenerated
{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    "example"
  ]
}