POST /orgs/{org}/actions/hosted-runners
Creates a GitHub-hosted runner for an organization.
OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
org |
String | Yes |
The organization name. 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 |
Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. |
size |
String | Yes |
The machine size of the runner. To list available sizes, use |
runner_group_id |
Integer | Yes |
The existing runner group to add this runner to. |
maximum_runners |
Integer | No |
The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. |
image |
Object | Yes |
The image of runner. To list all available images, use |
image.id |
String | No |
The unique identifier of the runner image. |
image.source |
String | No |
The source of the runner image. Possible values:
|
enable_static_ip |
Boolean | No |
Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.