Get a self-hosted runner for a repository

GET

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

Gets a specific 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 GET 'https://api.github.com/repos///actions/runners/'

Response Example

{
    "busy": true,
    "id": 5,
    "labels": [
        {
            "id": 0,
            "name": "string",
            "type": "read-only"
        }
    ],
    "name": "iMac",
    "os": "macos",
    "status": "online"
}

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.

Responses

🟢200Response

application/json

Body

A self hosted runner

busy

boolean

required

integer

required

The id of the runner.

Example:

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

name

string

required

The name of the runner.

Example:

iMac

string

required

The Operating System of the runner.

Example:

macos

status

string

required

The status of the runner.

Example:

online

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

Delete a self-hosted runner from a repository

Remove all custom labels from a self-hosted runner for a repository