Create a GitHub runner scale set installation

Creates a GitHub runner scale set installation for a team

POST

/github/runners/teams/{team_id}/scale_set_installations

Request Body

application/jsonRequired

`custom_image`string

Custom OCI image to use for scale set (default uses scale set)

`github_app_id`string

GitHub App ID

`github_app_installation_id`string

GitHub App Installation ID

`github_app_private_key`string

GitHub App Private Key (saved as secret)

`github_config_url`string

The URL (a org or repo) for which the scale set is configured

Format: "url"

`github_personal_access_token`
Deprecated
unknown

a personal access token that can be used to configure the runner (recommend using github app instead)

Format: "string"

`github_runner_group`string

name for the runner group to use, will create the group if it does not exist

Default: "devzero"

`github_runner_group_allow_public_repositories`boolean

allow the runner group to run on public repositories

Default: false

`region`string

Region for the scale set (defaults to first available if not provided)

`scale_set_id`
Required
integer

id for the scale set

Path Parameters

`team_id`
Required
string

team id

Header Parameters

`Authorization`
Required
string

sub claim pulled from the JWT that derives the user ID

curl -X POST "https://api.devzero.io/backend/v0/github/runners/teams/string/scale_set_installations" \
  -H "Authorization: string" \
  -H "Content-Type: application/json" \
  -d '{
    "custom_image": "string",
    "github_app_id": "string",
    "github_app_installation_id": "string",
    "github_app_private_key": "string",
    "github_config_url": "string",
    "github_personal_access_token": null,
    "github_runner_group": "devzero",
    "github_runner_group_allow_public_repositories": false,
    "region": "string",
    "scale_set_id": 0
  }'

{
  "custom_image": "string",
  "github_app_id": "string",
  "github_app_installation_id": "string",
  "github_app_private_key": "string",
  "github_config_url": "string",
  "github_personal_access_token": null,
  "github_runner_group": "devzero",
  "scale_set": {
    "cpu_limits": "string",
    "github_price_per_minute": 0.1,
    "id": 0,
    "image": "string",
    "memory_limits": "string",
    "name": "string",
    "price_per_minute": 0.1,
    "storage_size": "string"
  }
}

Create a GitHub runner scale set installation

Path

Headers

Body

Request Body

custom_imagestring

github_app_idstring

github_app_installation_idstring

github_app_private_keystring

github_config_urlstring

github_personal_access_tokenDeprecatedunknown

github_runner_groupstring

github_runner_group_allow_public_repositoriesboolean

regionstring

scale_set_idRequiredinteger