Add custom labels to a self-hosted runner for a repository

POST

/repos/{owner}/{repo}/actions/runners/{runner_id}/labels

Add custom labels to a self-hosted runner configured in a repository.

You must authenticate using an access token with the repo scope to use this
endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.github.com/repos///actions/runners//labels' \
--header 'Content-Type: application/json' \
--data-raw '{
    "labels": [
        "gpu",
        "accelerated"
    ]
}'

Response Example

200 - Example 1

{
    "labels": [
        {
            "id": 0,
            "name": "string",
            "type": "read-only"
        }
    ],
    "total_count": 0
}

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

runner_id

integer

required

Unique identifier of the self-hosted runner.

Body Params application/json

labels

array[string]

required

The names of the custom labels to add to the runner.

>= 1 items<= 100 items

Examples

Responses

🟢200Success

application/json

Body

labels

array[object (Self hosted runner label) {3}]

required

integer

optional

Unique identifier of the label.

name

string

required

Name of the label.

type

enum<string>

optional

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

Allowed values:

read-onlycustom

total_count

integer

required

🟠404404

🟠422422

Modified at 2023-08-15 02:59:24

List labels for a self-hosted runner for a repository

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