GitHub Actions 变量的 REST API 端点

列出组织变量

列出所有组织变量。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 应用程序令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。如果仓库是私有的，则还需要 repo 范围。

用于“列出组织变量”的细粒度访问令牌

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

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

“变量”组织权限（读取）

用于“列出组织变量”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。

查询参数
名称、类型、描述
`per_page` integer 每页结果数（最大 30）。有关更多信息，请参阅“在 REST API 中使用分页”。默认: `10`
`page` integer 要获取的结果的页码。有关更多信息，请参阅“在 REST API 中使用分页”。默认: `1`

用于“列出组织变量”的 HTTP 响应状态代码

状态代码	描述
`200`	OK

用于“列出组织变量”的代码示例

请求示例

get/orgs/{org}/actions/variables

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/variables

响应

状态: 200

{ "total_count": 3, "variables": [ { "name": "USERNAME", "value": "octocat", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "private" }, { "name": "ACTIONS_RUNNER_DEBUG", "value": true, "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "all" }, { "name": "ADMIN_EMAIL", "value": "[email protected]", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "selected", "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories" } ] }

创建组织变量

创建可以在 GitHub Actions 工作流程中引用的组织变量。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 令牌和个人访问令牌（经典）需要admin:org 范围才能使用此端点。如果仓库是私有的，OAuth 令牌和个人访问令牌（经典）需要repo 范围才能使用此端点。

用于“创建组织变量”的细粒度访问令牌

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

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

“变量”组织权限（写入）

用于“创建组织变量”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。

主体参数
名称、类型、描述
`name` 字符串必需变量的名称。
`value` 字符串必需变量的值。
`visibility` 字符串必需组织中可以访问变量的仓库类型。`selected` 表示只有由`selected_repository_ids` 指定的仓库才能访问变量。可以是以下之一： `all`, `private`, `selected`
`selected_repository_ids` 整数数组可以访问组织变量的仓库 ID 数组。只有在`visibility` 设置为`selected` 时，才能提供仓库 ID 列表。

用于“创建组织变量”的 HTTP 响应状态码

状态代码	描述
`201`	创建变量时的响应

用于“创建组织变量”的代码示例

请求示例

post/orgs/{org}/actions/variables

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/variables \ -d '{"name":"USERNAME","value":"octocat","visibility":"selected","selected_repository_ids":[1296269,1296280]}'

创建变量时的响应

状态：201

获取组织变量

获取组织中的特定变量。

经过身份验证的用户必须对存储库具有协作者访问权限才能创建、更新或读取变量。

用于“获取组织变量”的细粒度访问令牌

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

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

“变量”组织权限（读取）

“获取组织变量”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`name` 字符串必需变量的名称。

“获取组织变量”的 HTTP 响应状态代码

状态代码	描述
`200`	OK

“获取组织变量”的代码示例

请求示例

get/orgs/{org}/actions/variables/{name}

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/variables/NAME

响应

状态: 200

{ "name": "USERNAME", "value": "octocat", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "selected", "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" }

更新组织变量

更新您可以在 GitHub Actions 工作流程中引用的组织变量。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 应用程序令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。如果仓库是私有的，则还需要 repo 范围。

用于“更新组织变量”的细粒度访问令牌

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

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

“变量”组织权限（写入）

“更新组织变量”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`name` 字符串必需变量的名称。

主体参数
名称、类型、描述
`name` 字符串变量的名称。
`value` 字符串变量的值。
`visibility` 字符串组织中可以访问变量的仓库类型。`selected` 表示只有由`selected_repository_ids` 指定的仓库才能访问变量。可以是以下之一： `all`, `private`, `selected`
`selected_repository_ids` 整数数组可以访问组织变量的仓库 ID 数组。只有在`visibility` 设置为`selected` 时，才能提供仓库 ID 列表。

“更新组织变量”的 HTTP 响应状态代码

状态代码	描述
`204`	无内容

“更新组织变量”的代码示例

请求示例

patch/orgs/{org}/actions/variables/{name}

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/variables/NAME \ -d '{"name":"USERNAME","value":"octocat","visibility":"selected","selected_repository_ids":[1296269,1296280]}'

响应

状态：204

删除组织变量

使用变量名称删除组织变量。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

用于“删除组织变量”的细粒度访问令牌

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

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

“变量”组织权限（写入）

“删除组织变量”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`name` 字符串必需变量的名称。

“删除组织变量”的 HTTP 响应状态代码

状态代码	描述
`204`	无内容

“删除组织变量”的代码示例

请求示例

delete/orgs/{org}/actions/variables/{name}

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/variables/NAME

响应

状态：204

列出为组织变量选择的存储库

列出所有可以访问对选定存储库可用的组织变量的存储库。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 应用程序令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。如果仓库是私有的，则还需要 repo 范围。

用于“列出为组织变量选择的存储库”的细粒度访问令牌

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

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

“变量”组织权限（读取）

用于“列出为组织变量选择的存储库”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`name` 字符串必需变量的名称。

查询参数
名称、类型、描述
`page` integer 要获取的结果的页码。有关更多信息，请参阅“在 REST API 中使用分页”。默认: `1`
`per_page` integer 每页结果数（最大 100）。有关更多信息，请参阅“在 REST API 中使用分页”。默认: `30`

用于“列出为组织变量选择的存储库”的 HTTP 响应状态代码

状态代码	描述
`200`	OK
`409`	当变量的可见性未设置为`selected`时的响应

“列出为组织变量选择的存储库”的代码示例

请求示例

get/orgs/{org}/actions/variables/{name}/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/variables/NAME/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}",
      "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
    }
  ]
}

为组织变量设置选定的存储库

替换对选定存储库可用的组织变量的所有存储库。对选定存储库可用的组织变量的visibility字段设置为selected。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 应用程序令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。如果仓库是私有的，则还需要 repo 范围。

用于“为组织变量设置选定的存储库”的细粒度访问令牌

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

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

“变量”组织权限（写入）

用于“为组织变量设置选定的存储库”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`name` 字符串必需变量的名称。

主体参数
名称、类型、描述
`selected_repository_ids` 整数数组必需可以访问组织变量的存储库的 ID。

用于“为组织变量设置选定的存储库”的 HTTP 响应状态代码

状态代码	描述
`204`	无内容
`409`	当变量的可见性未设置为`selected`时的响应

“为组织变量设置选定的存储库”的代码示例

请求示例

put/orgs/{org}/actions/variables/{name}/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/variables/NAME/repositories \ -d '{"selected_repository_ids":[64780797]}'

响应

状态：204

将选定的存储库添加到组织变量

将存储库添加到对选定存储库可用的组织变量。对选定存储库可用的组织变量的visibility字段设置为selected。

经过身份验证的用户必须对存储库具有协作者访问权限才能创建、更新或读取机密。

OAuth 令牌和个人访问令牌（经典）需要 `admin:org` 范围才能使用此端点。如果存储库是私有的，OAuth 令牌和个人访问令牌（经典）需要 `repo` 范围才能使用此端点。

用于“将选定存储库添加到组织变量”的细粒度访问令牌

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

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

"变量" 组织权限（写入）和 "元数据" 存储库权限（读取）

用于“将选定存储库添加到组织变量”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`name` 字符串必需变量的名称。
`repository_id` 整数必需

用于“将选定存储库添加到组织变量”的 HTTP 响应状态代码

状态代码	描述
`204`	无内容
`409`	当变量的可见性未设置为`selected`时的响应

用于“将选定存储库添加到组织变量”的代码示例

请求示例

put/orgs/{org}/actions/variables/{name}/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/variables/NAME/repositories/REPOSITORY_ID

响应

状态：204

从组织变量中删除选定存储库

从可用于选定存储库的组织变量中删除存储库。可用于选定存储库的组织变量的 `visibility` 字段设置为 `selected`。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 应用程序令牌和个人访问令牌（经典）需要 admin:org 范围才能使用此端点。如果仓库是私有的，则还需要 repo 范围。

用于“从组织变量中删除选定存储库”的细粒度访问令牌

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

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

"变量" 组织权限（写入）和 "元数据" 存储库权限（读取）

用于“从组织变量中删除选定存储库”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`name` 字符串必需变量的名称。
`repository_id` 整数必需

用于“从组织变量中删除选定存储库”的 HTTP 响应状态代码

状态代码	描述
`204`	无内容
`409`	当变量的可见性未设置为`selected`时的响应

用于“从组织变量中删除选定存储库”的代码示例

请求示例

delete/orgs/{org}/actions/variables/{name}/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/variables/NAME/repositories/REPOSITORY_ID

响应

状态：204

列出存储库组织变量

列出与存储库共享的所有组织变量。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 应用程序令牌和个人访问令牌（经典）需要 `repo` 范围才能使用此端点。

用于“列出存储库组织变量”的细粒度访问令牌

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

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

"变量" 存储库权限（读取）

用于“列出存储库组织变量”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需存储库的名称，不包含`.git`扩展名。名称不区分大小写。

查询参数
名称、类型、描述
`per_page` integer 每页结果数（最大 30）。有关更多信息，请参阅“在 REST API 中使用分页”。默认: `10`
`page` integer 要获取的结果的页码。有关更多信息，请参阅“在 REST API 中使用分页”。默认: `1`

“列出存储库组织变量”的 HTTP 响应状态代码

状态代码	描述
`200`	OK

“列出存储库组织变量”的代码示例

请求示例

get/repos/{owner}/{repo}/actions/organization-variables

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/repos/OWNER/REPO/actions/organization-variables

响应

状态: 200

{ "total_count": 2, "variables": [ { "name": "USERNAME", "value": "octocat", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z" }, { "name": "EMAIL", "value": "[email protected]", "created_at": "2020-01-10T10:59:22Z", "updated_at": "2020-01-11T11:59:22Z" } ] }

列出存储库变量

列出所有存储库变量。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 应用程序令牌和个人访问令牌（经典）需要 `repo` 范围才能使用此端点。

“列出存储库变量”的细粒度访问令牌

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

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

"变量" 存储库权限（读取）

“列出存储库变量”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需存储库的名称，不包含`.git`扩展名。名称不区分大小写。

查询参数
名称、类型、描述
`per_page` integer 每页结果数（最大 30）。有关更多信息，请参阅“在 REST API 中使用分页”。默认: `10`
`page` integer 要获取的结果的页码。有关更多信息，请参阅“在 REST API 中使用分页”。默认: `1`

“列出存储库变量”的 HTTP 响应状态代码

状态代码	描述
`200`	OK

“列出存储库变量”的代码示例

请求示例

get/repos/{owner}/{repo}/actions/variables

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/repos/OWNER/REPO/actions/variables

响应

状态: 200

{ "total_count": 2, "variables": [ { "name": "USERNAME", "value": "octocat", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z" }, { "name": "EMAIL", "value": "[email protected]", "created_at": "2020-01-10T10:59:22Z", "updated_at": "2020-01-11T11:59:22Z" } ] }

创建存储库变量

创建一个存储库变量，您可以在 GitHub Actions 工作流程中引用它。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 令牌和个人访问令牌（经典）需要repo范围才能使用此端点。

“创建存储库变量”的细粒度访问令牌

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

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

“变量”存储库权限（写入）

“创建存储库变量”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需存储库的名称，不包含`.git`扩展名。名称不区分大小写。

主体参数
名称、类型、描述
`name` 字符串必需变量的名称。
`value` 字符串必需变量的值。

创建仓库变量的 HTTP 响应状态码

状态代码	描述
`201`	已创建

创建仓库变量的代码示例

请求示例

post/repos/{owner}/{repo}/actions/variables

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/repos/OWNER/REPO/actions/variables \ -d '{"name":"USERNAME","value":"octocat"}'

响应

状态：201

获取仓库变量

获取仓库中的特定变量。

经过身份验证的用户必须具有对仓库的协作者访问权限才能使用此端点。

OAuth 应用程序令牌和个人访问令牌（经典）需要 `repo` 范围才能使用此端点。

获取仓库变量的细粒度访问令牌

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

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

"变量" 存储库权限（读取）

获取仓库变量的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需存储库的名称，不包含`.git`扩展名。名称不区分大小写。
`name` 字符串必需变量的名称。

获取仓库变量的 HTTP 响应状态码

状态代码	描述
`200`	OK

获取仓库变量的代码示例

请求示例

get/repos/{owner}/{repo}/actions/variables/{name}

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/repos/OWNER/REPO/actions/variables/NAME

响应

状态: 200

{ "name": "USERNAME", "value": "octocat", "created_at": "2021-08-10T14:59:22Z", "updated_at": "2022-01-10T14:59:22Z" }

更新仓库变量

更新您可以在 GitHub Actions 工作流程中引用的仓库变量。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 应用程序令牌和个人访问令牌（经典）需要 `repo` 范围才能使用此端点。

更新仓库变量的细粒度访问令牌

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

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

“变量”存储库权限（写入）

更新仓库变量的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需存储库的名称，不包含`.git`扩展名。名称不区分大小写。
`name` 字符串必需变量的名称。

主体参数
名称、类型、描述
`name` 字符串变量的名称。
`value` 字符串变量的值。

更新仓库变量的 HTTP 响应状态码

状态代码	描述
`204`	无内容

更新仓库变量的代码示例

请求示例

patch/repos/{owner}/{repo}/actions/variables/{name}

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/repos/OWNER/REPO/actions/variables/NAME \ -d '{"name":"USERNAME","value":"octocat"}'

响应

状态：204

删除仓库变量

使用变量名称删除仓库变量。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 令牌和个人访问令牌（经典）需要repo范围才能使用此端点。

删除仓库变量的细粒度访问令牌

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

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

“变量”存储库权限（写入）

删除仓库变量的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需存储库的名称，不包含`.git`扩展名。名称不区分大小写。
`name` 字符串必需变量的名称。

删除仓库变量的 HTTP 响应状态码

状态代码	描述
`204`	无内容

删除仓库变量的代码示例

请求示例

delete/repos/{owner}/{repo}/actions/variables/{name}

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/repos/OWNER/REPO/actions/variables/NAME

响应

状态：204

列出环境变量

列出所有环境变量。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 应用程序令牌和个人访问令牌（经典）需要 `repo` 范围才能使用此端点。

列出环境变量的细粒度访问令牌

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

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

"变量" 存储库权限（读取）和 "环境" 存储库权限（读取）

列出环境变量的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需存储库的名称，不包含`.git`扩展名。名称不区分大小写。
`environment_name` 字符串必需环境的名称。名称必须进行 URL 编码。例如，名称中的任何斜杠都必须替换为 `%2F`。

查询参数
名称、类型、描述
`per_page` integer 每页结果数（最大 30）。有关更多信息，请参阅“在 REST API 中使用分页”。默认: `10`
`page` integer 要获取的结果的页码。有关更多信息，请参阅“在 REST API 中使用分页”。默认: `1`

列出环境变量的 HTTP 响应状态代码

状态代码	描述
`200`	OK

列出环境变量的代码示例

请求示例

get/repos/{owner}/{repo}/environments/{environment_name}/variables

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/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/variables

响应

状态: 200

{ "total_count": 2, "variables": [ { "name": "USERNAME", "value": "octocat", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z" }, { "name": "EMAIL", "value": "[email protected]", "created_at": "2020-01-10T10:59:22Z", "updated_at": "2020-01-11T11:59:22Z" } ] }

创建环境变量

创建可以在 GitHub Actions 工作流程中引用的环境变量。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 令牌和个人访问令牌（经典）需要repo范围才能使用此端点。

创建环境变量的细粒度访问令牌

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

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

"变量" 存储库权限（写入）和 "环境" 存储库权限（写入）

创建环境变量的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需存储库的名称，不包含`.git`扩展名。名称不区分大小写。
`environment_name` 字符串必需环境的名称。名称必须进行 URL 编码。例如，名称中的任何斜杠都必须替换为 `%2F`。

主体参数
名称、类型、描述
`name` 字符串必需变量的名称。
`value` 字符串必需变量的值。

创建环境变量的 HTTP 响应状态代码

状态代码	描述
`201`	已创建

创建环境变量的代码示例

请求示例

post/repos/{owner}/{repo}/environments/{environment_name}/variables

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/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/variables \ -d '{"name":"USERNAME","value":"octocat"}'

响应

状态：201

获取环境变量

获取环境中的特定变量。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 令牌和个人访问令牌（经典）需要repo范围才能使用此端点。

获取环境变量的细粒度访问令牌

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

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

"变量" 存储库权限（读取）和 "环境" 存储库权限（读取）

获取环境变量的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需存储库的名称，不包含`.git`扩展名。名称不区分大小写。
`environment_name` 字符串必需环境的名称。名称必须进行 URL 编码。例如，名称中的任何斜杠都必须替换为 `%2F`。
`name` 字符串必需变量的名称。

获取环境变量的 HTTP 响应状态代码

状态代码	描述
`200`	OK

获取环境变量的代码示例

请求示例

get/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}

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/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/variables/NAME

响应

状态: 200

{ "name": "USERNAME", "value": "octocat", "created_at": "2021-08-10T14:59:22Z", "updated_at": "2022-01-10T14:59:22Z" }

更新环境变量

更新可以在 GitHub Actions 工作流程中引用的环境变量。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 应用程序令牌和个人访问令牌（经典）需要 `repo` 范围才能使用此端点。

更新环境变量的细粒度访问令牌

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

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

"变量" 存储库权限（写入）和 "环境" 存储库权限（写入）

更新环境变量的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需存储库的名称，不包含`.git`扩展名。名称不区分大小写。
`name` 字符串必需变量的名称。
`environment_name` 字符串必需环境的名称。名称必须进行 URL 编码。例如，名称中的任何斜杠都必须替换为 `%2F`。

主体参数
名称、类型、描述
`name` 字符串变量的名称。
`value` 字符串变量的值。

更新环境变量的 HTTP 响应状态码

状态代码	描述
`204`	无内容

更新环境变量的代码示例

请求示例

patch/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}

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/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/variables/NAME \ -d '{"name":"USERNAME","value":"octocat"}'

响应

状态：204

删除环境变量

使用变量名称删除环境变量。

经过身份验证的用户必须对仓库具有协作者访问权限才能创建、更新或读取变量。

OAuth 令牌和个人访问令牌（经典）需要repo范围才能使用此端点。

删除环境变量的细粒度访问令牌

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

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

"变量" 存储库权限（写入）和 "环境" 存储库权限（写入）

删除环境变量的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`owner` string 必需存储库的帐户所有者。名称不区分大小写。
`repo` string 必需存储库的名称，不包含`.git`扩展名。名称不区分大小写。
`name` 字符串必需变量的名称。
`environment_name` 字符串必需环境的名称。名称必须进行 URL 编码。例如，名称中的任何斜杠都必须替换为 `%2F`。

删除环境变量的 HTTP 响应状态码

状态代码	描述
`204`	无内容

删除环境变量的代码示例

请求示例

delete/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}

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/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/variables/NAME

响应

状态：204