GitHub: Create configuration for a just-in-time runner for a repository

GitHub actions.actionsGenerateRunnerJitconfigForRepo: arguments, response, policy and SDK examples.

Operation github.actions_generate_runner_jitconfig_for_repo

Provider route: POST /repos/{owner}/{repo}/actions/runners/generate-jitconfig. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["actions"]["actionsGenerateRunnerJitconfigForRepo"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.actions.actionsGenerateRunnerJitconfigForRepo(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.actions.actions_generate_runner_jitconfig_for_repo(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.owner`	string	Required within parent
`path.repo`	string	Required within parent
`body`	Model	Required within parent	Expand Create configuration for a just-in-time runner for a repository — request body — body

Referenced models: Create configuration for a just-in-time runner for a repository — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	object	Root
`encoded_jit_config`	string	Required within parent	The base64 encoded runner configuration.
`runner`	Model	Required within parent	Expand Get a self-hosted runner for a repository — response body

Referenced models: Get a self-hosted runner for a repository — response body

Schemas

Get a self-hosted runner for a repository — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A self hosted runner
`busy`	boolean	Required within parent
`ephemeral`	boolean	Optional
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	The ID of the runner.
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`labels`	array	Required within parent
`labels[]`	Model	Each item	Expand Get a self-hosted runner for a repository — response body — labels item
`name`	string	Required within parent	The name of the runner.
`os`	string	Required within parent	The Operating System of the runner.
`runner_group_id`	JSON	Optional
`runner_group_id (anyOf 1)`	integer	Alternative	The ID of the runner group.
`runner_group_id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`status`	string	Required within parent	The status of the runner.
`version`	JSON	Optional
`version (anyOf 1)`	string	Alternative	The version of the GitHub Actions Runner software. This is only set if the runner has connected to the service at least once.
`version (anyOf 2)`	null	Alternative

Referenced models: Get a self-hosted runner for a repository — response body — labels item

Create configuration for a just-in-time runner for a repository — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`labels`	array	Required within parent	The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100. Maximum items: 100 Minimum items: 1
`labels[]`	string	Each item
`name`	string	Required within parent	The name of the new runner.
`runner_group_id`	integer	Required within parent	The ID of the runner group to register the runner to.
`work_folder`	string	Optional	The working directory to be used for job execution, relative to the runner install directory. Default: _work

Get a self-hosted runner for a repository — response body — labels item

Field	Type	Presence	Description and constraints
`$`	object	Root	A label for a self hosted runner
`id`	JSON	Optional
`id (anyOf 1)`	integer	Alternative	Unique identifier of the label.
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`name`	string	Required within parent	Name of the label.
`type`	string	Optional	The type of label. Read-only labels are applied automatically when the runner is configured. Known values: read-only, custom

Policy, approvals and errors

SDK function policy ID: github.actions_generate_runner_jitconfig_for_repo. Catalog operation: actions/generate-runner-jitconfig-for-repo. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page