Get a self-hosted runner for a repository

3 parameters

ownerstringrequired

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

repostringrequired

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

runner_idintegerrequired

Unique identifier of the self-hosted runner.

1 status code

200Response

idintegerrequired

The ID of the runner.

runner_group_idintegeroptional

The ID of the runner group.

namestringrequired

The name of the runner.

osstringrequired

The Operating System of the runner.

statusstringrequired

The status of the runner.

busybooleanrequired

labelsarray<SelfHostedRunnerLabel>required

ephemeralbooleanoptional

versionstringoptional

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

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.runners.get({
  owner: "octocat",
  repo: "hello-world",
  runnerId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
});

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

Request

Response