GitHub: Set custom labels for a self-hosted runner for a repository

← Actions operations · Get started

Operation github.actions_set_custom_labels_for_self_hosted_runner_for_repo

Provider route: PUT /repos/{owner}/{repo}/actions/runners/{runner_id}/labels. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["actions"]["actionsSetCustomLabelsForSelfHostedRunnerForRepo"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.actions.actionsSetCustomLabelsForSelfHostedRunnerForRepo(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.actions.actions_set_custom_labels_for_self_hosted_runner_for_repo(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent
path.runner_id	integer	Required within parent
body	object	Required within parent
body.labels	array	Required within parent	The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. Maximum items: 100 Minimum items: 0
body.labels[]	string	Each item

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root
labels	array	Required within parent
labels[]	Model	Each item	Expand Get a self-hosted runner for a repository — response body — labels item
total_count	JSON	Required within parent
total_count (anyOf 1)	integer	Alternative
total_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get a self-hosted runner for a repository — response body — labels item

Schemas

Get a self-hosted runner for a repository — response body — labels item

Field	Type	Presence	Description and constraints
$	object	Root	A label for a self hosted runner
id	JSON	Optional
id (anyOf 1)	integer	Alternative	Unique identifier of the label.
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	Name of the label.
type	string	Optional	The type of label. Read-only labels are applied automatically when the runner is configured. Known values: read-only, custom

Policy, approvals and errors

SDK function policy ID: github.actions_set_custom_labels_for_self_hosted_runner_for_repo. Catalog operation: actions/set-custom-labels-for-self-hosted-runner-for-repo. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source