provider actions POST /orgs/{org}/actions/runners/generate-jitconfig
@utdk/github /orgs/{org}/actions/runners/generate-jitconfig
Create configuration for a just-in-time runner for an organization
Generates a configuration that can be passed to the runner application at startup. The authenticated user must have admin access to the organization. OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org path required
The organization name. The name is not case sensitive.
string

Try it

Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

actions.generateRunnerJitconfigForOrg
POST/orgs/{org}/actions/runners/generate-jitconfig
Generates a configuration that can be passed to the runner application at startup. The authenticated user must have admin access to the organization. OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.

Parameters

required

The organization name. The name is not case sensitive.

Input

required

The name of the new runner.

required

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

required

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

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

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.actions.generateRunnerJitconfigForOrg({
  "work_folder": "_work"
})