actions

Create configuration for a just-in-time runner for an Enterprise

Changed on

Generates a configuration that can be passed to the runner application at startup.

OAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

post/enterprises/{enterprise}/actions/runners/generate-jitconfig

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/enterprises/{enterprise}/actions/runners/generate-jitconfig
  • Auth: none declared

Path parameters

enterprisestring required

The slug version of the enterprise name.

Request body

namestring required

The name of the new runner.

runner_group_idinteger required

The ID of the runner group to register the runner to.

labelsstring[] required

The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.

work_folderstring

The working directory to be used for job execution, relative to the runner install directory.

Response

Response

encoded_jit_configstring required

The base64 encoded runner configuration.

Example response

{
  "runner": {
    "id": 5,
    "runner_group_id": 1,
    "name": "iMac",
    "os": "macos",
    "status": "online",
    "version": "2.323.0"
  }
}

Changes