Skip to content
forgit api docs

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.

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

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

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

repo
required
string

The name of the repository without the .git extension. The name is not case sensitive.

runner_id
required
integer

Unique identifier of the self-hosted runner.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Self hosted runners

A self hosted runner

object
id
required

The ID of the runner.

integer
runner_group_id

The ID of the runner group.

integer
name
required

The name of the runner.

string
os
required

The Operating System of the runner.

string
status
required

The status of the runner.

string
busy
required
boolean
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
ephemeral
boolean
version

The version of the GitHub Actions Runner software. This is only set if the runner has connected to the service at least once.

string
nullable
Examples
Example default 
{
  "id": 23,
  "name": "MBP",
  "os": "macos",
  "status": "online",
  "busy": true,
  "ephemeral": false,
  "version": "2.323.0",
  "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"
    }
  ]
}