GitHub托管的运行程序
使用 REST API 与 GitHub 中的 GitHub Actions 托管运行器进行交互。
List GitHub-hosted runners for an enterprise
Lists all GitHub-hosted runners configured in an enterprise.
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
fine_grained_access
no_fine_grained_access
“”List GitHub-hosted runners for an enterprise 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
| 名称, 类型, 说明 |
|---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runnersResponse
Status: 200{
"total_count": 2,
"runners": [
{
"id": 5,
"name": "My hosted ubuntu runner",
"runner_group_id": 2,
"platform": "linux-x64",
"image": {
"id": "ubuntu-20.04",
"size": 86
},
"machine_size_details": {
"id": "4-core",
"cpu_cores": 4,
"memory_gb": 16,
"storage_gb": 150
},
"status": "Ready",
"maximum_runners": 10,
"public_ip_enabled": true,
"public_ips": [
{
"enabled": true,
"prefix": "20.80.208.150",
"length": 31
}
],
"last_active_on": "2022-10-09T23:39:01Z"
},
{
"id": 7,
"name": "My hosted Windows runner",
"runner_group_id": 2,
"platform": "win-x64",
"image": {
"id": "windows-latest",
"size": 256
},
"machine_size_details": {
"id": "8-core",
"cpu_cores": 8,
"memory_gb": 32,
"storage_gb": 300
},
"status": "Ready",
"maximum_runners": 20,
"public_ip_enabled": false,
"public_ips": [],
"last_active_on": "2023-04-26T15:23:37Z"
}
]
}Create a GitHub-hosted runner for an enterprise
Creates a GitHub-hosted runner for an enterprise.
OAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
fine_grained_access
no_fine_grained_access
“”Create a GitHub-hosted runner for an enterprise 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
| 名称, 类型, 说明 | ||||
|---|---|---|---|---|
name string 必须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 object 必须The image of runner. To list all available images, use | ||||
Properties of |
| 名称, 类型, 说明 |
|---|
id string The unique identifier of the runner image. |
source string The source of the runner image. 可以是以下选项之一: |
version string or null The version of the runner image to deploy. This is relevant only for runners using custom images. |
size string 必须The machine size of the runner. To list available sizes, use GET actions/hosted-runners/machine-sizes
runner_group_id integer 必须The existing runner group to add this runner to.
maximum_runners integer The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.
默认: 50
enable_static_ip boolean Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use GET actions/hosted-runners/limits
默认: false
image_gen boolean Whether this runner should be used to generate custom images.
默认: false
http_status_code
| status_code | 说明 |
|---|---|
201 | Created |
code_samples
data_residency_notice
request_example
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners \
-d '{"name":"My Hosted runner","image":{"id":"ubuntu-latest","source":"github"},"runner_group_id":1,"size":"4-core","maximum_runners":10}'Response
Status: 201{
"id": 5,
"name": "My hosted ubuntu runner",
"runner_group_id": 2,
"platform": "linux-x64",
"image": {
"id": "ubuntu-20.04",
"size": 86
},
"machine_size_details": {
"id": "4-core",
"cpu_cores": 4,
"memory_gb": 16,
"storage_gb": 150
},
"status": "Ready",
"maximum_runners": 10,
"public_ip_enabled": true,
"public_ips": [
{
"enabled": true,
"prefix": "20.80.208.150",
"length": 31
}
],
"last_active_on": "2022-10-09T23:39:01Z"
}List custom images for an enterprise
List custom images for an enterprise.
OAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
fine_grained_access
no_fine_grained_access
“”List custom images for an enterprise 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners/images/customResponse
Status: 200{
"total_count": 2,
"image_versions": [
{
"version": "1.1.0",
"size_gb": 75,
"state": "Ready",
"created_on": "2024-11-09T23:39:01Z"
},
{
"version": "1.0.0",
"size_gb": 75,
"state": "Ready",
"created_on": "2024-11-08T20:39:01Z"
}
]
}Get an enterprise custom image definition for GitHub Actions Hosted Runners
Get an enterprise custom image definition for GitHub Actions Hosted Runners.
OAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
fine_grained_access
no_fine_grained_access
“”Get an enterprise custom image definition for GitHub Actions Hosted Runners 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
image_definition_id integer 必须Image definition ID of custom image |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners/images/custom/IMAGE_DEFINITION_IDResponse
Status: 200{
"id": 1,
"platform": "linux-x64",
"name": "CustomImage",
"source": "custom",
"versions_count": 4,
"total_versions_size": 200,
"latest_version": "1.3.0",
"state": "Ready"
}Delete a custom image from the enterprise
Delete a custom image from the enterprise.
OAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
fine_grained_access
no_fine_grained_access
“”Delete a custom image from the enterprise 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
image_definition_id integer 必须Image definition ID of custom image |
http_status_code
| status_code | 说明 |
|---|---|
204 | No Content |
code_samples
data_residency_notice
request_example
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners/images/custom/IMAGE_DEFINITION_IDResponse
Status: 204List image versions of a custom image for an enterprise
List image versions of a custom image for an enterprise.
OAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
fine_grained_access
no_fine_grained_access
“”List image versions of a custom image for an enterprise 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
image_definition_id integer 必须Image definition ID of custom image |
enterprise string 必须The slug version of the enterprise name. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners/images/custom/IMAGE_DEFINITION_ID/versionsResponse
Status: 200{
"total_count": 2,
"image_versions": [
{
"version": "1.1.0",
"size_gb": 75,
"state": "Ready",
"created_on": "2024-11-09T23:39:01Z"
},
{
"version": "1.0.0",
"size_gb": 75,
"state": "Ready",
"created_on": "2024-11-08T20:39:01Z"
}
]
}Get an image version of an enterprise custom image for GitHub Actions Hosted Runners
Get an image version of an enterprise custom image for GitHub Actions Hosted Runners.
OAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
fine_grained_access
no_fine_grained_access
“”Get an image version of an enterprise custom image for GitHub Actions Hosted Runners 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
image_definition_id integer 必须Image definition ID of custom image |
version string 必须Version of a custom image |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners/images/custom/IMAGE_DEFINITION_ID/versions/VERSIONResponse
Status: 200{
"version": "1.0.0",
"size_gb": 75,
"state": "Ready",
"created_on": "2024-11-08T20:39:01Z"
}Delete an image version of custom image from the enterprise
Delete an image version of custom image from the enterprise.
OAuth tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
fine_grained_access
no_fine_grained_access
“”Delete an image version of custom image from the enterprise 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
image_definition_id integer 必须Image definition ID of custom image |
version string 必须Version of a custom image |
http_status_code
| status_code | 说明 |
|---|---|
204 | No Content |
code_samples
data_residency_notice
request_example
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners/images/custom/IMAGE_DEFINITION_ID/versions/VERSIONResponse
Status: 204Get GitHub-owned images for GitHub-hosted runners in an enterprise
Get the list of GitHub-owned images available for GitHub-hosted runners for an enterprise.
fine_grained_access
no_fine_grained_access
“”Get GitHub-owned images for GitHub-hosted runners in an enterprise 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners/images/github-ownedResponse
Status: 200{
"id": "ubuntu-20.04",
"platform": "linux-x64",
"size_gb": 86,
"display_name": "20.04",
"source": "github"
}Get partner images for GitHub-hosted runners in an enterprise
Get the list of partner images available for GitHub-hosted runners for an enterprise.
fine_grained_access
no_fine_grained_access
“”Get partner images for GitHub-hosted runners in an enterprise 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners/images/partnerResponse
Status: 200{
"id": "ubuntu-20.04",
"platform": "linux-x64",
"size_gb": 86,
"display_name": "20.04",
"source": "github"
}Get limits on GitHub-hosted runners for an enterprise
Get the GitHub-hosted runners limits for an enterprise.
fine_grained_access
no_fine_grained_access
“”Get limits on GitHub-hosted runners for an enterprise 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners/limitsResponse
Status: 200{
"public_ips": {
"current_usage": 17,
"maximum": 50
}
}Get GitHub-hosted runners machine specs for an enterprise
Get the list of machine specs available for GitHub-hosted runners for an enterprise.
fine_grained_access
no_fine_grained_access
“”Get GitHub-hosted runners machine specs for an enterprise 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners/machine-sizesResponse
Status: 200{
"id": "4-core",
"cpu_cores": 4,
"memory_gb": 16,
"storage_gb": 150
}Get platforms for GitHub-hosted runners in an enterprise
Get the list of platforms available for GitHub-hosted runners for an enterprise.
fine_grained_access
no_fine_grained_access
“”Get platforms for GitHub-hosted runners in an enterprise 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners/platformsResponse
Status: 200{
"total_count": 1,
"platforms": [
"linux-x64",
"win-x64"
]
}Get a GitHub-hosted runner for an enterprise
Gets a GitHub-hosted runner configured in an enterprise.
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
fine_grained_access
no_fine_grained_access
“”Get a GitHub-hosted runner for an enterprise 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
hosted_runner_id integer 必须Unique identifier of the GitHub-hosted runner. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners/HOSTED_RUNNER_IDResponse
Status: 200{
"id": 5,
"name": "My hosted ubuntu runner",
"runner_group_id": 2,
"platform": "linux-x64",
"image": {
"id": "ubuntu-20.04",
"size": 86
},
"machine_size_details": {
"id": "4-core",
"cpu_cores": 4,
"memory_gb": 16,
"storage_gb": 150
},
"status": "Ready",
"maximum_runners": 10,
"public_ip_enabled": true,
"public_ips": [
{
"enabled": true,
"prefix": "20.80.208.150",
"length": 31
}
],
"last_active_on": "2022-10-09T23:39:01Z"
}Update a GitHub-hosted runner for an enterprise
Updates a GitHub-hosted runner for an enterprise.
OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.
fine_grained_access
no_fine_grained_access
“”Update a GitHub-hosted runner for an enterprise 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
hosted_runner_id integer 必须Unique identifier of the GitHub-hosted runner. |
| 名称, 类型, 说明 |
|---|
name string 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 '_'. |
runner_group_id integer The existing runner group to add this runner to. |
maximum_runners integer 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 boolean Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use |
size string The machine size of the runner. To list available sizes, use |
image_source string The source type of the runner image to use. Must match the source of the image specified by 可以是以下选项之一: |
image_id string The unique identifier of the runner image. To list available images, use |
image_version string or null The version of the runner image to deploy. This is relevant only for runners using custom images. |
image_gen boolean Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners/HOSTED_RUNNER_ID \
-d '{"name":"My Hosted runner","runner_group_id":1,"maximum_runners":50,"enable_static_ip":false}'Response
Status: 200{
"id": 5,
"name": "My hosted ubuntu runner",
"runner_group_id": 2,
"platform": "linux-x64",
"image": {
"id": "ubuntu-20.04",
"size": 86
},
"machine_size_details": {
"id": "4-core",
"cpu_cores": 4,
"memory_gb": 16,
"storage_gb": 150
},
"status": "Ready",
"maximum_runners": 10,
"public_ip_enabled": true,
"public_ips": [
{
"enabled": true,
"prefix": "20.80.208.150",
"length": 31
}
],
"last_active_on": "2022-10-09T23:39:01Z"
}Delete a GitHub-hosted runner for an enterprise
Deletes a GitHub-hosted runner for an enterprise.
fine_grained_access
no_fine_grained_access
“”Delete a GitHub-hosted runner for an enterprise 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
enterprise string 必须The slug version of the enterprise name. |
hosted_runner_id integer 必须Unique identifier of the GitHub-hosted runner. |
http_status_code
| status_code | 说明 |
|---|---|
202 | Accepted |
code_samples
data_residency_notice
request_example
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/enterprises/ENTERPRISE/actions/hosted-runners/HOSTED_RUNNER_IDResponse
Status: 202{
"id": 5,
"name": "My hosted ubuntu runner",
"runner_group_id": 2,
"platform": "linux-x64",
"image": {
"id": "ubuntu-20.04",
"size": 86
},
"machine_size_details": {
"id": "4-core",
"cpu_cores": 4,
"memory_gb": 16,
"storage_gb": 150
},
"status": "Ready",
"maximum_runners": 10,
"public_ip_enabled": true,
"public_ips": [
{
"enabled": true,
"prefix": "20.80.208.150",
"length": 31
}
],
"last_active_on": "2022-10-09T23:39:01Z"
}List GitHub-hosted runners for an organization
Lists all GitHub-hosted runners configured in an organization.
OAuth app tokens and personal access tokens (classic) need the manage_runner:org scope to use this endpoint.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Administration" organization permissions (read)
“”List GitHub-hosted runners for an organization 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
| 名称, 类型, 说明 |
|---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runnersResponse
Status: 200{
"total_count": 2,
"runners": [
{
"id": 5,
"name": "My hosted ubuntu runner",
"runner_group_id": 2,
"platform": "linux-x64",
"image": {
"id": "ubuntu-20.04",
"size": 86
},
"machine_size_details": {
"id": "4-core",
"cpu_cores": 4,
"memory_gb": 16,
"storage_gb": 150
},
"status": "Ready",
"maximum_runners": 10,
"public_ip_enabled": true,
"public_ips": [
{
"enabled": true,
"prefix": "20.80.208.150",
"length": 31
}
],
"last_active_on": "2022-10-09T23:39:01Z"
},
{
"id": 7,
"name": "My hosted Windows runner",
"runner_group_id": 2,
"platform": "win-x64",
"image": {
"id": "windows-latest",
"size": 256
},
"machine_size_details": {
"id": "8-core",
"cpu_cores": 8,
"memory_gb": 32,
"storage_gb": 300
},
"status": "Ready",
"maximum_runners": 20,
"public_ip_enabled": false,
"public_ips": [],
"last_active_on": "2023-04-26T15:23:37Z"
}
]
}Create a GitHub-hosted runner for an organization
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.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Administration" organization permissions (write)
“”Create a GitHub-hosted runner for an organization 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
| 名称, 类型, 说明 | ||||
|---|---|---|---|---|
name string 必须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 object 必须The image of runner. To list all available images, use | ||||
Properties of |
| 名称, 类型, 说明 |
|---|
id string The unique identifier of the runner image. |
source string The source of the runner image. 可以是以下选项之一: |
version string or null The version of the runner image to deploy. This is relevant only for runners using custom images. |
size string 必须The machine size of the runner. To list available sizes, use GET actions/hosted-runners/machine-sizes
runner_group_id integer 必须The existing runner group to add this runner to.
maximum_runners integer 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 boolean Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use GET actions/hosted-runners/limits
image_gen boolean Whether this runner should be used to generate custom images.
默认: false
http_status_code
| status_code | 说明 |
|---|---|
201 | Created |
code_samples
data_residency_notice
request_example
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners \
-d '{"name":"My Hosted runner","image":{"id":"ubuntu-latest","source":"github"},"runner_group_id":1,"size":"4-core","maximum_runners":50,"enable_static_ip":false}'Response
Status: 201{
"id": 5,
"name": "My hosted ubuntu runner",
"runner_group_id": 2,
"platform": "linux-x64",
"image": {
"id": "ubuntu-20.04",
"size": 86
},
"machine_size_details": {
"id": "4-core",
"cpu_cores": 4,
"memory_gb": 16,
"storage_gb": 150
},
"status": "Ready",
"maximum_runners": 10,
"public_ip_enabled": true,
"public_ips": [
{
"enabled": true,
"prefix": "20.80.208.150",
"length": 31
}
],
"last_active_on": "2022-10-09T23:39:01Z"
}List custom images for an organization
List custom images for an organization.
OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Hosted runner custom images" organization permissions (read)
“”List custom images for an organization 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners/images/customResponse
Status: 200{
"total_count": 2,
"image_versions": [
{
"version": "1.1.0",
"size_gb": 75,
"state": "Ready",
"created_on": "2024-11-09T23:39:01Z"
},
{
"version": "1.0.0",
"size_gb": 75,
"state": "Ready",
"created_on": "2024-11-08T20:39:01Z"
}
]
}Get a custom image definition for GitHub Actions Hosted Runners
Get a custom image definition for GitHub Actions Hosted Runners.
OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Hosted runner custom images" organization permissions (read)
“”Get a custom image definition for GitHub Actions Hosted Runners 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
image_definition_id integer 必须Image definition ID of custom image |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners/images/custom/IMAGE_DEFINITION_IDResponse
Status: 200{
"id": 1,
"platform": "linux-x64",
"name": "CustomImage",
"source": "custom",
"versions_count": 4,
"total_versions_size": 200,
"latest_version": "1.3.0",
"state": "Ready"
}Delete a custom image from the organization
Delete a custom image from the organization.
OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Hosted runner custom images" organization permissions (write)
“”Delete a custom image from the organization 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
image_definition_id integer 必须Image definition ID of custom image |
http_status_code
| status_code | 说明 |
|---|---|
204 | No Content |
code_samples
data_residency_notice
request_example
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners/images/custom/IMAGE_DEFINITION_IDResponse
Status: 204List image versions of a custom image for an organization
List image versions of a custom image for an organization.
OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Hosted runner custom images" organization permissions (read)
“”List image versions of a custom image for an organization 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
image_definition_id integer 必须Image definition ID of custom image |
org string 必须The organization name. The name is not case sensitive. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners/images/custom/IMAGE_DEFINITION_ID/versionsResponse
Status: 200{
"total_count": 2,
"image_versions": [
{
"version": "1.1.0",
"size_gb": 75,
"state": "Ready",
"created_on": "2024-11-09T23:39:01Z"
},
{
"version": "1.0.0",
"size_gb": 75,
"state": "Ready",
"created_on": "2024-11-08T20:39:01Z"
}
]
}Get an image version of a custom image for GitHub Actions Hosted Runners
Get an image version of a custom image for GitHub Actions Hosted Runners.
OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Hosted runner custom images" organization permissions (read)
“”Get an image version of a custom image for GitHub Actions Hosted Runners 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
image_definition_id integer 必须Image definition ID of custom image |
version string 必须Version of a custom image |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners/images/custom/IMAGE_DEFINITION_ID/versions/VERSIONResponse
Status: 200{
"version": "1.0.0",
"size_gb": 75,
"state": "Ready",
"created_on": "2024-11-08T20:39:01Z"
}Delete an image version of custom image from the organization
Delete an image version of custom image from the organization.
OAuth tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Hosted runner custom images" organization permissions (write)
“”Delete an image version of custom image from the organization 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
image_definition_id integer 必须Image definition ID of custom image |
version string 必须Version of a custom image |
http_status_code
| status_code | 说明 |
|---|---|
204 | No Content |
code_samples
data_residency_notice
request_example
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners/images/custom/IMAGE_DEFINITION_ID/versions/VERSIONResponse
Status: 204Get GitHub-owned images for GitHub-hosted runners in an organization
Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Administration" organization permissions (read)
“”Get GitHub-owned images for GitHub-hosted runners in an organization 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners/images/github-ownedResponse
Status: 200{
"id": "ubuntu-20.04",
"platform": "linux-x64",
"size_gb": 86,
"display_name": "20.04",
"source": "github"
}Get partner images for GitHub-hosted runners in an organization
Get the list of partner images available for GitHub-hosted runners for an organization.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Administration" organization permissions (read)
“”Get partner images for GitHub-hosted runners in an organization 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners/images/partnerResponse
Status: 200{
"id": "ubuntu-20.04",
"platform": "linux-x64",
"size_gb": 86,
"display_name": "20.04",
"source": "github"
}Get limits on GitHub-hosted runners for an organization
Get the GitHub-hosted runners limits for an organization.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Administration" organization permissions (read)
“”Get limits on GitHub-hosted runners for an organization 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners/limitsResponse
Status: 200{
"public_ips": {
"current_usage": 17,
"maximum": 50
}
}Get GitHub-hosted runners machine specs for an organization
Get the list of machine specs available for GitHub-hosted runners for an organization.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Administration" organization permissions (read)
“”Get GitHub-hosted runners machine specs for an organization 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners/machine-sizesResponse
Status: 200{
"id": "4-core",
"cpu_cores": 4,
"memory_gb": 16,
"storage_gb": 150
}Get platforms for GitHub-hosted runners in an organization
Get the list of platforms available for GitHub-hosted runners for an organization.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Administration" organization permissions (read)
“”Get platforms for GitHub-hosted runners in an organization 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners/platformsResponse
Status: 200{
"total_count": 1,
"platforms": [
"linux-x64",
"win-x64"
]
}Get a GitHub-hosted runner for an organization
Gets a GitHub-hosted runner configured in an organization.
OAuth app tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Administration" organization permissions (read)
“”Get a GitHub-hosted runner for an organization 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
hosted_runner_id integer 必须Unique identifier of the GitHub-hosted runner. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners/HOSTED_RUNNER_IDResponse
Status: 200{
"id": 5,
"name": "My hosted ubuntu runner",
"runner_group_id": 2,
"platform": "linux-x64",
"image": {
"id": "ubuntu-20.04",
"size": 86
},
"machine_size_details": {
"id": "4-core",
"cpu_cores": 4,
"memory_gb": 16,
"storage_gb": 150
},
"status": "Ready",
"maximum_runners": 10,
"public_ip_enabled": true,
"public_ips": [
{
"enabled": true,
"prefix": "20.80.208.150",
"length": 31
}
],
"last_active_on": "2022-10-09T23:39:01Z"
}Update a GitHub-hosted runner for an organization
Updates a GitHub-hosted runner for an organization.
OAuth app tokens and personal access tokens (classic) need the manage_runners:org scope to use this endpoint.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Administration" organization permissions (write)
“”Update a GitHub-hosted runner for an organization 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
hosted_runner_id integer 必须Unique identifier of the GitHub-hosted runner. |
| 名称, 类型, 说明 |
|---|
name string 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 '_'. |
runner_group_id integer The existing runner group to add this runner to. |
maximum_runners integer 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 boolean Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use |
size string The machine size of the runner. To list available sizes, use |
image_source string The source type of the runner image to use. Must match the source of the image specified by 可以是以下选项之一: |
image_id string The unique identifier of the runner image. To list available images, use |
image_version string or null The version of the runner image to deploy. This is relevant only for runners using custom images. |
image_gen boolean Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images. |
http_status_code
| status_code | 说明 |
|---|---|
200 | OK |
code_samples
data_residency_notice
request_example
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners/HOSTED_RUNNER_ID \
-d '{"name":"My larger runner","runner_group_id":1,"maximum_runners":50,"enable_static_ip":false}'Response
Status: 200{
"id": 5,
"name": "My hosted ubuntu runner",
"runner_group_id": 2,
"platform": "linux-x64",
"image": {
"id": "ubuntu-20.04",
"size": 86
},
"machine_size_details": {
"id": "4-core",
"cpu_cores": 4,
"memory_gb": 16,
"storage_gb": 150
},
"status": "Ready",
"maximum_runners": 10,
"public_ip_enabled": true,
"public_ips": [
{
"enabled": true,
"prefix": "20.80.208.150",
"length": 31
}
],
"last_active_on": "2022-10-09T23:39:01Z"
}Delete a GitHub-hosted runner for an organization
Deletes a GitHub-hosted runner for an organization.
fine_grained_access
works_with_fine_grained_tokens:
permission_set:
- "Administration" organization permissions (write)
“”Delete a GitHub-hosted runner for an organization 的参数
| 名称, 类型, 说明 |
|---|
accept string Setting to |
| 名称, 类型, 说明 |
|---|
org string 必须The organization name. The name is not case sensitive. |
hosted_runner_id integer 必须Unique identifier of the GitHub-hosted runner. |
http_status_code
| status_code | 说明 |
|---|---|
202 | Accepted |
code_samples
data_residency_notice
request_example
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2026-03-10" \
https://api.github.com/orgs/ORG/actions/hosted-runners/HOSTED_RUNNER_IDResponse
Status: 202{
"id": 5,
"name": "My hosted ubuntu runner",
"runner_group_id": 2,
"platform": "linux-x64",
"image": {
"id": "ubuntu-20.04",
"size": 86
},
"machine_size_details": {
"id": "4-core",
"cpu_cores": 4,
"memory_gb": 16,
"storage_gb": 150
},
"status": "Ready",
"maximum_runners": 10,
"public_ip_enabled": true,
"public_ips": [
{
"enabled": true,
"prefix": "20.80.208.150",
"length": 31
}
],
"last_active_on": "2022-10-09T23:39:01Z"
}