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

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

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.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters · 1 body field

orgstringrequired

The organization name. The name is not case sensitive.

runner_idintegerrequired

Unique identifier of the self-hosted runner.

labelsarray<string>required

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

3 status codes

200Response

total_countintegerrequired

labelsarray<SelfHostedRunnerLabel>required

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

422Validation failed, or the endpoint has been spammed.

messagestringrequired

documentation_urlstringrequired

errorsarray<string>optional

Error handling

A 404 is returned: Resource not found. A 422 is returned: Validation failed, or the endpoint has been spammed.

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.labels.update({
  org: "acme-inc",
  runnerId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  labels: [],
});

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

Request

Response

Errors