REST API 现在已版本化。 更多信息，请参阅“关于 API 版本控制”。

用于自托管运行器组的 REST API 端点

使用 REST API 与 GitHub Actions 的自托管运行器组交互。

关于 GitHub Actions 中的自托管运行器组

您可以使用 REST API 管理 GitHub Actions 中的自托管运行器组。更多信息，请参阅“使用组管理自托管运行器的访问权限”。

这些端点可供已验证用户、OAuth 应用和 GitHub 应用使用。访问令牌需要 repo 作用域 用于私有仓库，以及 public_repo 作用域 用于公共仓库。GitHub 应用必须具有仓库的 administration 权限或组织的 organization_self_hosted_runners 权限。已验证用户必须对仓库或组织具有管理员访问权限，或者对企业具有 manage_runners:enterprise 作用域才能使用这些端点。

列出组织的自托管运行器组

列出在组织中配置的并从企业继承的所有自托管运行器组。

OAuth 应用令牌和个人访问令牌（经典版）需要 admin:org 作用域才能使用此端点。

用于“列出组织的自托管运行器组”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “自托管运行器”组织权限（读取）

用于“列出组织的自托管运行器组”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

查询参数
per_page 整数

每页结果数（最大 100）。更多信息，请参阅“在 REST API 中使用分页”。

默认： 30

page 整数

要提取的结果的页码。更多信息，请参阅“在 REST API 中使用分页”。

默认： 1

visible_to_repository 字符串

仅返回此仓库可以使用运行器组。

用于“列出组织的自托管运行器组”的 HTTP 响应状态代码

状态代码描述
200

OK

用于“列出组织的自托管运行器组”的代码示例

请求示例

get/orgs/{org}/actions/runner-groups
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/actions/runner-groups

响应

状态：200
{ "total_count": 3, "runner_groups": [ { "id": 1, "name": "Default", "visibility": "all", "default": true, "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": false, "selected_workflows": [], "workflow_restrictions_read_only": false }, { "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "inherited": true, "allows_public_repositories": true, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": true }, { "id": 3, "name": "expensive-hardware", "visibility": "private", "default": false, "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": false, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false } ] }

为组织创建自托管运行器组

为组织创建一个新的自托管运行器组。

OAuth 令牌和个人访问令牌（经典版）需要 admin:org 作用域才能使用此端点。

用于“为组织创建自托管运行器组”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “自托管运行器”组织权限（写入）

用于“为组织创建自托管运行器组”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

主体参数
name 字符串 必需

运行器组的名称。

visibility 字符串

运行器组的可见性。您可以选择所有仓库、选择单个仓库或将访问权限限制为私有仓库。

默认： all

可以是以下之一： selected, all, private

selected_repository_ids 整数数组

可以访问运行器组的仓库 ID 列表。

runners 整数数组

要添加到运行器组的运行器 ID 列表。

allows_public_repositories 布尔值

运行器组是否可以由public 仓库使用。

默认： false

restricted_to_workflows 布尔值

如果为 true，则运行器组将仅限于运行 selected_workflows 数组中指定的 workflow。

默认： false

selected_workflows 字符串数组

运行器组应允许运行的 workflow 列表。除非将 restricted_to_workflows 设置为 true，否则将忽略此设置。

用于“为组织创建自托管运行器组”的 HTTP 响应状态代码

状态代码描述
201

已创建

用于“为组织创建自托管运行器组”的代码示例

请求示例

post/orgs/{org}/actions/runner-groups
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/actions/runner-groups \ -d '{"name":"Expensive hardware runners","visibility":"selected","selected_repository_ids":[32,91],"runners":[9,2]}'

响应

状态：201
{ "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }

获取组织的自托管运行器组

获取组织的特定自托管运行器组。

OAuth 应用令牌和个人访问令牌（经典版）需要 admin:org 作用域才能使用此端点。

用于“获取组织的自托管运行器组”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “自托管运行器”组织权限（读取）

用于“获取组织的自托管运行器组”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

runner_group_id 整数 必填

自托管运行器组的唯一标识符。

“获取组织的自托管运行器组”的HTTP响应状态码

状态代码描述
200

OK

“获取组织的自托管运行器组”的代码示例

请求示例

get/orgs/{org}/actions/runner-groups/{runner_group_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID

响应

状态：200
{ "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }

更新组织的自托管运行器组

更新组织中自托管运行器组的name和visibility。

OAuth 应用令牌和个人访问令牌（经典版）需要 admin:org 作用域才能使用此端点。

“更新组织的自托管运行器组”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “自托管运行器”组织权限（写入）

“更新组织的自托管运行器组”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

runner_group_id 整数 必填

自托管运行器组的唯一标识符。

主体参数
name 字符串 必需

运行器组的名称。

visibility 字符串

运行器组的可见性。您可以选择所有仓库、选择单个仓库或所有私有仓库。

可以是以下之一： selected, all, private

allows_public_repositories 布尔值

运行器组是否可以由public 仓库使用。

默认： false

restricted_to_workflows 布尔值

如果为 true，则运行器组将仅限于运行 selected_workflows 数组中指定的 workflow。

默认： false

selected_workflows 字符串数组

运行器组应允许运行的 workflow 列表。除非将 restricted_to_workflows 设置为 true，否则将忽略此设置。

“更新组织的自托管运行器组”的HTTP响应状态码

状态代码描述
200

OK

“更新组织的自托管运行器组”的代码示例

请求示例

patch/orgs/{org}/actions/runner-groups/{runner_group_id}
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID \ -d '{"name":"Expensive hardware runners","visibility":"selected"}'

响应

状态：200
{ "id": 2, "name": "octo-runner-group", "visibility": "selected", "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": true, "selected_workflows": [ "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" ], "workflow_restrictions_read_only": false }

从组织中删除自托管运行器组

删除组织的自托管运行器组。

OAuth 令牌和个人访问令牌（经典版）需要 admin:org 作用域才能使用此端点。

“从组织中删除自托管运行器组”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “自托管运行器”组织权限（写入）

“从组织中删除自托管运行器组”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

runner_group_id 整数 必填

自托管运行器组的唯一标识符。

“从组织中删除自托管运行器组”的HTTP响应状态码

状态代码描述
204

无内容

“从组织中删除自托管运行器组”的代码示例

请求示例

delete/orgs/{org}/actions/runner-groups/{runner_group_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID

响应

状态: 204

列出组织中自托管运行器组的仓库访问权限

列出配置在组织中的自托管运行器组可以访问的仓库。

OAuth 应用令牌和个人访问令牌（经典版）需要 admin:org 作用域才能使用此端点。

“列出组织中自托管运行器组的仓库访问权限”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “自托管运行器”组织权限（读取）

“列出组织中自托管运行器组的仓库访问权限”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

runner_group_id 整数 必填

自托管运行器组的唯一标识符。

查询参数
page 整数

要提取的结果的页码。更多信息，请参阅“在 REST API 中使用分页”。

默认： 1

per_page 整数

每页结果数（最大 100）。更多信息，请参阅“在 REST API 中使用分页”。

默认： 30

“列出组织中自托管运行器组的仓库访问权限”的HTTP响应状态码

状态代码描述
200

OK

“列出组织中自托管运行器组的仓库访问权限”的代码示例

请求示例

get/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID/repositories

响应

状态：200
{ "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "[email protected]:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "template_repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "[email protected]:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "organization": null, "language": null, "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "watchers": 80, "size": 108, "default_branch": "master", "open_issues": 0, "open_issues_count": 0, "is_template": true, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://api.github.com/licenses/mit" }, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0 }, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "delete_branch_on_merge": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==" }, "forks": 1, "open_issues": 1, "watchers": 1 } ] }

设置组织中自托管运行器组的仓库访问权限

替换配置在组织中的自托管运行器组可以访问的仓库列表。

OAuth 应用令牌和个人访问令牌（经典版）需要 admin:org 作用域才能使用此端点。

为组织中的自托管运行器组“设置代码库访问权限”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “自托管运行器”组织权限（写入）

为“设置组织中自托管运行器组的代码库访问权限”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

runner_group_id 整数 必填

自托管运行器组的唯一标识符。

主体参数
selected_repository_ids 整数数组 必需

可以访问运行器组的仓库 ID 列表。

为“设置组织中自托管运行器组的代码库访问权限”的HTTP响应状态码

状态代码描述
204

无内容

为“设置组织中自托管运行器组的代码库访问权限”的代码示例

请求示例

put/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID/repositories \ -d '{"selected_repository_ids":[32,91]}'

响应

状态: 204

向组织中的自托管运行器组添加代码库访问权限

将代码库添加到可以访问自托管运行器组的代码库列表中。运行器组必须将visibility设置为selected。更多信息，请参阅“为组织创建自托管运行器组”。

OAuth 令牌和个人访问令牌（经典版）需要 admin:org 作用域才能使用此端点。

为“向组织中的自托管运行器组添加代码库访问权限”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “自托管运行器”组织权限（写入） 和 “元数据”代码库权限（读取）

为“向组织中的自托管运行器组添加代码库访问权限”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

runner_group_id 整数 必填

自托管运行器组的唯一标识符。

repository_id 整数 必需

代码库的唯一标识符。

为“向组织中的自托管运行器组添加代码库访问权限”的HTTP响应状态码

状态代码描述
204

无内容

为“向组织中的自托管运行器组添加代码库访问权限”的代码示例

请求示例

put/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID/repositories/REPOSITORY_ID

响应

状态: 204

从组织中的自托管运行器组删除代码库访问权限

从可以选择访问自托管运行器组的代码库列表中删除一个代码库。运行器组必须将visibility设置为selected。更多信息，请参阅“为组织创建自托管运行器组”。

OAuth 应用令牌和个人访问令牌（经典版）需要 admin:org 作用域才能使用此端点。

为“从组织中的自托管运行器组删除代码库访问权限”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “自托管运行器”组织权限（写入） 和 “元数据”代码库权限（读取）

为“从组织中的自托管运行器组删除代码库访问权限”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

runner_group_id 整数 必填

自托管运行器组的唯一标识符。

repository_id 整数 必需

代码库的唯一标识符。

为“从组织中的自托管运行器组删除代码库访问权限”的HTTP响应状态码

状态代码描述
204

无内容

为“从组织中的自托管运行器组删除代码库访问权限”的代码示例

请求示例

delete/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID/repositories/REPOSITORY_ID

响应

状态: 204

列出组织中组的自托管运行器

列出位于特定组织组中的自托管运行器。

OAuth 应用令牌和个人访问令牌（经典版）需要 admin:org 作用域才能使用此端点。

为“列出组织中组的自托管运行器”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “自托管运行器”组织权限（读取）

为“列出组织中组的自托管运行器”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

runner_group_id 整数 必填

自托管运行器组的唯一标识符。

查询参数
per_page 整数

每页结果数（最大 100）。更多信息，请参阅“在 REST API 中使用分页”。

默认： 30

page 整数

要提取的结果的页码。更多信息，请参阅“在 REST API 中使用分页”。

默认： 1

为“列出组织中组的自托管运行器”的HTTP响应状态码

状态代码描述
200

OK

为“列出组织中组的自托管运行器”的代码示例

请求示例

get/orgs/{org}/actions/runner-groups/{runner_group_id}/runners
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID/runners

响应

状态：200
{ "total_count": 2, "runners": [ { "id": 23, "name": "linux_runner", "os": "linux", "status": "online", "busy": true, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 11, "name": "Linux", "type": "read-only" } ] }, { "id": 24, "name": "mac_runner", "os": "macos", "status": "offline", "busy": false, "labels": [ { "id": 5, "name": "self-hosted", "type": "read-only" }, { "id": 7, "name": "X64", "type": "read-only" }, { "id": 20, "name": "macOS", "type": "read-only" }, { "id": 21, "name": "no-gpu", "type": "custom" } ] } ] }

设置组织中组的自托管运行器

替换属于组织运行器组的自托管运行器列表。

OAuth 应用令牌和个人访问令牌（经典版）需要 admin:org 作用域才能使用此端点。

为“设置组织中组的自托管运行器”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “自托管运行器”组织权限（写入）

为“设置组织中组的自托管运行器”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

runner_group_id 整数 必填

自托管运行器组的唯一标识符。

主体参数
runners 整数数组 必需

要添加到运行器组的运行器 ID 列表。

为“设置组织中组的自托管运行器”的HTTP响应状态码

状态代码描述
204

无内容

为“设置组织中组的自托管运行器”的代码示例

请求示例

put/orgs/{org}/actions/runner-groups/{runner_group_id}/runners
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID/runners \ -d '{"runners":[9,2]}'

响应

状态: 204

向组织中的组添加自托管运行器

将自托管运行器添加到在组织中配置的运行器组。

OAuth 令牌和个人访问令牌（经典版）需要 admin:org 作用域才能使用此端点。

为“向组织中的组添加自托管运行器”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “自托管运行器”组织权限（写入）

为“向组织中的组添加自托管运行器”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

runner_group_id 整数 必填

自托管运行器组的唯一标识符。

runner_id 整数 必需

自托管运行器的唯一标识符。

为“向组织中的组添加自托管运行器”的HTTP响应状态码

状态代码描述
204

无内容

为“向组织中的组添加自托管运行器”的代码示例

请求示例

put/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID/runners/RUNNER_ID

响应

状态: 204

从组织中的组删除自托管运行器

从在组织中配置的组中删除自托管运行器。然后，运行器将返回到默认组。

OAuth 应用令牌和个人访问令牌（经典版）需要 admin:org 作用域才能使用此端点。

为“从组织中的组删除自托管运行器”的细粒度访问令牌

此端点适用于以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “自托管运行器”组织权限（写入）

为“从组织中的组删除自托管运行器”的参数

标头
accept 字符串

建议设置为 application/vnd.github+json。

路径参数
org 字符串 必需

组织名称。名称不区分大小写。

runner_group_id 整数 必填

自托管运行器组的唯一标识符。

runner_id 整数 必需

自托管运行器的唯一标识符。

为“从组织中的组删除自托管运行器”的HTTP响应状态码

状态代码描述
204

无内容

为“从组织中的组删除自托管运行器”的代码示例

请求示例

delete/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/actions/runner-groups/RUNNER_GROUP_ID/runners/RUNNER_ID

响应

状态: 204