Get a self-hosted runner for an enterprise

Gets a specific self-hosted runner configured in an enterprise. You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.

GET/enterprises/{enterprise}/actions/runners/{runner_id}

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

enterprise string required: The slug version of the enterprise name. You can also substitute this value with the enterprise id.
runner_id integer required: Unique identifier of the self-hosted runner.

Responses

application/json Self hosted runners object

Response

busy boolean

required

id integer

required

The id of the runner.

Example: 5

labels array[Self hosted runner label object]

required

items Self hosted runner label object

A label for a self hosted runner

id integer

optional

Unique identifier of the label.

name string

required

Name of the label.

type string

optional

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

Allowed: "read-only""custom"

name string

required

The name of the runner.

Example: iMac

os string

required

The Operating System of the runner.

Example: macos

status string

required

The status of the runner.

Example: online

Response Example: 200 application/json

{
  "busy": true,
  "id": 23,
  "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"
    }
  ],
  "name": "MBP",
  "os": "macos",
  "status": "online"
}

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

enterprise *

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

runner_id *

Unique identifier of the self-hosted runner.

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/enterprises/{enterprise}/actions/runners/{runner_id}