feat: new /enterprises/{enterprise}/actions/hosted-runners, `/orgs/… · octokit/plugin-rest-endpoint-methods.js@b3fe977 (original) (raw)
``
1
`+
`
``
2
`+
name: Create a GitHub-hosted runner for an organization
`
``
3
`+
example: octokit.rest.actions.createHostedRunnerForOrg({ org, name, image, size, runner_group_id })
`
``
4
`+
route: POST /orgs/{org}/actions/hosted-runners
`
``
5
`+
scope: actions
`
``
6
`+
type: API method
`
``
7
`+
`
``
8
+
``
9
`+
Create a GitHub-hosted runner for an organization
`
``
10
+
``
11
`+
Creates a GitHub-hosted runner for an organization.
`
``
12
`` +
OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
``
``
13
+
``
14
```js
``
15
`+
octokit.rest.actions.createHostedRunnerForOrg({
`
``
16
`+
org,
`
``
17
`+
name,
`
``
18
`+
image,
`
``
19
`+
size,
`
``
20
`+
runner_group_id,
`
``
21
`+
});
`
``
22
```
``
23
+
``
24
`+
Parameters
`
``
25
+
``
26
`+
| name | required | description |
|---|---|---|
| org | yes |
` ``
``
`+ The organization name. The name is not case sensitive. ` ``
``
`+ |
| name | 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 '_'. ` ``
``
`+ |
| image | yes |
` ``
``
`` + The image of runner. To list all available images, use `` ``
``
`+ |
| image.id | no |
` ``
``
`+ The unique identifier of the runner image. ` ``
``
`+ |
| image.source | no |
` ``
``
`+ The source of the runner image. ` ``
``
`+ |
| size | yes |
` ``
``
`` + The machine size of the runner. To list available sizes, use `` ``
``
`+ |
| runner_group_id | yes |
` ``
``
`+ The existing runner group to add this runner to. ` ``
``
`+ |
| maximum_runners | 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. ` ``
``
`+ |
| enable_static_ip | no |
` ``
``
`` + Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `` ``
``
`+ |
`
``
82
+
``
83
`+
See also: GitHub Developer Guide documentation.
`