POST /repos/{owner}/{repo}/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 repository.

OAuth tokens and personal access tokens (classic) need therepo scope to use this endpoint.

Servers

Path parameters

Name Type Required Description
repo String Yes

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

owner String Yes

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

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
name String Yes

The name of the new runner.

labels[] Array Yes

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

runner_group_id Integer Yes

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

work_folder String No

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

Default value: "_work"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.