GitHub Actions 变量
使用 REST API 与 GitHub Actions 中的变量进行交互。
关于 GitHub Actions 中的变量
可以使用 REST API 创建、更新、删除和检索可在 GitHub Actions 中的工作流中使用的变量的信息。 变量允许在存储库、存储库环境或组织中存储非敏感信息，例如用户名。
这些终结点适用于经过身份验证的用户、OAuth Apps 和 GitHub Apps。 对于专用存储库，访问令牌需要 repo 范围，对于 公共给 存储库，则需要 public_repo 范围。 GitHub Apps 必须具有 actions_variables/environments/organization_actions_variables 权限才可使用这些终结点。 经过身份验证的用户必须对存储库具有协作者权限才可创建、更新或读取变量。
List organization variables
Lists all organization variables. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
“List organization variables”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
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 30). 默认: |
page integer Page number of the results to fetch. 默认: |
“List organization variables”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | OK |
“List 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/orgs/ORG/actions/variablesResponse
Status: 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": "octocat@github.com",
"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"
}
]
}Create an organization variable
Creates an organization variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the admin:org scope to use this endpoint.
GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
“Create an organization variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
org string 必选The organization name. The name is not case sensitive. |
| 正文参数 |
| 名称, 类型, 说明 |
name string 必选The name of the variable. |
value string 必选The value of the variable. |
visibility string 必选The type of repositories in the organization that can access the variable. 可以是以下选项之一: |
selected_repository_ids array of integers An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the |
“Create an organization variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
201 | Response when creating a variable |
“Create an organization variable”的示例代码
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]}'Response when creating a variable
Status: 201Get an organization variable
Gets a specific variable in an organization. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
“Get an organization variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
org string 必选The organization name. The name is not case sensitive. |
name string 必选The name of the variable. |
“Get an organization variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | OK |
“Get an organization variable”的示例代码
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/NAMEResponse
Status: 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"
}Update an organization variable
Updates an organization variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the admin:org scope to use this endpoint.
GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
“Update an organization variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
org string 必选The organization name. The name is not case sensitive. |
name string 必选The name of the variable. |
| 正文参数 |
| 名称, 类型, 说明 |
name string The name of the variable. |
value string The value of the variable. |
visibility string The type of repositories in the organization that can access the variable. 可以是以下选项之一: |
selected_repository_ids array of integers An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the |
“Update an organization variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
204 | No Content |
“Update an organization variable”的示例代码
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]}'Response
Status: 204Delete an organization variable
Deletes an organization variable using the variable name.
You must authenticate using an access token with the admin:org scope to use this endpoint.
GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
“Delete an organization variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
org string 必选The organization name. The name is not case sensitive. |
name string 必选The name of the variable. |
“Delete an organization variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
204 | No Content |
“Delete an organization variable”的示例代码
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/NAMEResponse
Status: 204List selected repositories for an organization variable
Lists all repositories that can access an organization variable that is available to selected repositories. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:read organization permission to use this endpoint.
“List selected repositories for an organization variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
org string 必选The organization name. The name is not case sensitive. |
name string 必选The name of the variable. |
| 查询参数 |
| 名称, 类型, 说明 |
page integer Page number of the results to fetch. 默认: |
per_page integer The number of results per page (max 100). 默认: |
“List selected repositories for an organization variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | OK |
409 | Response when the visibility of the variable is not set to |
“List selected repositories for an organization variable”的示例代码
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/repositoriesResponse
Status: 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": "git@github.com: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"
}
]
}Set selected repositories for an organization variable
Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
“Set selected repositories for an organization variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
org string 必选The organization name. The name is not case sensitive. |
name string 必选The name of the variable. |
| 正文参数 |
| 名称, 类型, 说明 |
selected_repository_ids array of integers 必选The IDs of the repositories that can access the organization variable. |
“Set selected repositories for an organization variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
204 | No Content |
409 | Response when the visibility of the variable is not set to |
“Set selected repositories for an organization variable”的示例代码
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]}'Response
Status: 204Add selected repository to an organization variable
Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
“Add selected repository to an organization variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
org string 必选The organization name. The name is not case sensitive. |
name string 必选The name of the variable. |
repository_id integer 必选 |
“Add selected repository to an organization variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
204 | No Content |
409 | Response when the visibility of the variable is not set to |
“Add selected repository to an organization variable”的示例代码
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_IDResponse
Status: 204Remove selected repository from an organization variable
Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the organization_actions_variables:write organization permission to use this endpoint.
“Remove selected repository from an organization variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
org string 必选The organization name. The name is not case sensitive. |
name string 必选The name of the variable. |
repository_id integer 必选 |
“Remove selected repository from an organization variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
204 | No Content |
409 | Response when the visibility of the variable is not set to |
“Remove selected repository from an organization variable”的示例代码
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_IDResponse
Status: 204List repository organization variables
Lists all organiation variables shared with a repository. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions_variables:read repository permission to use this endpoint.
“List repository organization variables”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
owner string 必选The account owner of the repository. The name is not case sensitive. |
repo string 必选The name of the repository. The name is not case sensitive. |
| 查询参数 |
| 名称, 类型, 说明 |
per_page integer The number of results per page (max 30). 默认: |
page integer Page number of the results to fetch. 默认: |
“List repository organization variables”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | OK |
“List repository 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-variablesResponse
Status: 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": "octocat@github.com",
"created_at": "2020-01-10T10:59:22Z",
"updated_at": "2020-01-11T11:59:22Z"
}
]
}List repository variables
Lists all repository variables. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions_variables:read repository permission to use this endpoint.
“List repository variables”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
owner string 必选The account owner of the repository. The name is not case sensitive. |
repo string 必选The name of the repository. The name is not case sensitive. |
| 查询参数 |
| 名称, 类型, 说明 |
per_page integer The number of results per page (max 30). 默认: |
page integer Page number of the results to fetch. 默认: |
“List repository variables”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | OK |
“List repository 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/variablesResponse
Status: 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": "octocat@github.com",
"created_at": "2020-01-10T10:59:22Z",
"updated_at": "2020-01-11T11:59:22Z"
}
]
}Create a repository variable
Creates a repository variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the repo scope to use this endpoint.
GitHub Apps must have the actions_variables:write repository permission to use this endpoint.
“Create a repository variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
owner string 必选The account owner of the repository. The name is not case sensitive. |
repo string 必选The name of the repository. The name is not case sensitive. |
| 正文参数 |
| 名称, 类型, 说明 |
name string 必选The name of the variable. |
value string 必选The value of the variable. |
“Create a repository variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
201 | Created |
“Create a repository variable”的示例代码
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"}'Response
Status: 201Get a repository variable
Gets a specific variable in a repository. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions_variables:read repository permission to use this endpoint.
“Get a repository variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
owner string 必选The account owner of the repository. The name is not case sensitive. |
repo string 必选The name of the repository. The name is not case sensitive. |
name string 必选The name of the variable. |
“Get a repository variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | OK |
“Get a repository variable”的示例代码
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/NAMEResponse
Status: 200{
"name": "USERNAME",
"value": "octocat",
"created_at": "2021-08-10T14:59:22Z",
"updated_at": "2022-01-10T14:59:22Z"
}Update a repository variable
Updates a repository variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the repo scope to use this endpoint.
GitHub Apps must have the actions_variables:write repository permission to use this endpoint.
“Update a repository variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
owner string 必选The account owner of the repository. The name is not case sensitive. |
repo string 必选The name of the repository. The name is not case sensitive. |
name string 必选The name of the variable. |
| 正文参数 |
| 名称, 类型, 说明 |
name string The name of the variable. |
value string The value of the variable. |
“Update a repository variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
204 | No Content |
“Update a repository variable”的示例代码
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"}'Response
Status: 204Delete a repository variable
Deletes a repository variable using the variable name.
You must authenticate using an access token with the repo scope to use this endpoint.
GitHub Apps must have the actions_variables:write repository permission to use this endpoint.
“Delete a repository variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
owner string 必选The account owner of the repository. The name is not case sensitive. |
repo string 必选The name of the repository. The name is not case sensitive. |
name string 必选The name of the variable. |
“Delete a repository variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
204 | No Content |
“Delete a repository variable”的示例代码
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/NAMEResponse
Status: 204List environment variables
Lists all environment variables. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the environments:read repository permission to use this endpoint.
“List environment variables”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
repository_id integer 必选The unique identifier of the repository. |
environment_name string 必选The name of the environment. |
| 查询参数 |
| 名称, 类型, 说明 |
per_page integer The number of results per page (max 30). 默认: |
page integer Page number of the results to fetch. 默认: |
“List environment variables”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | OK |
“List environment 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/repositories/REPOSITORY_ID/environments/ENVIRONMENT_NAME/variablesResponse
Status: 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": "octocat@github.com",
"created_at": "2020-01-10T10:59:22Z",
"updated_at": "2020-01-11T11:59:22Z"
}
]
}Create an environment variable
Create an environment variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the repo scope to use this endpoint.
GitHub Apps must have the environment:write repository permission to use this endpoint.
“Create an environment variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
repository_id integer 必选The unique identifier of the repository. |
environment_name string 必选The name of the environment. |
| 正文参数 |
| 名称, 类型, 说明 |
name string 必选The name of the variable. |
value string 必选The value of the variable. |
“Create an environment variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
201 | Created |
“Create an environment variable”的示例代码
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/repositories/REPOSITORY_ID/environments/ENVIRONMENT_NAME/variables \
-d '{"name":"USERNAME","value":"octocat"}'Response
Status: 201Get an environment variable
Gets a specific variable in an environment. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the environments:read repository permission to use this endpoint.
“Get an environment variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
repository_id integer 必选The unique identifier of the repository. |
environment_name string 必选The name of the environment. |
name string 必选The name of the variable. |
“Get an environment variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
200 | OK |
“Get an environment variable”的示例代码
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/repositories/REPOSITORY_ID/environments/ENVIRONMENT_NAME/variables/NAMEResponse
Status: 200{
"name": "USERNAME",
"value": "octocat",
"created_at": "2021-08-10T14:59:22Z",
"updated_at": "2022-01-10T14:59:22Z"
}Update an environment variable
Updates an environment variable that you can reference in a GitHub Actions workflow.
You must authenticate using an access token with the repo scope to use this endpoint.
GitHub Apps must have the environment:write repository permission to use this endpoint.
“Update an environment variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
repository_id integer 必选The unique identifier of the repository. |
name string 必选The name of the variable. |
environment_name string 必选The name of the environment. |
| 正文参数 |
| 名称, 类型, 说明 |
name string The name of the variable. |
value string The value of the variable. |
“Update an environment variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
204 | No Content |
“Update an environment variable”的示例代码
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/repositories/REPOSITORY_ID/environments/ENVIRONMENT_NAME/variables/NAME \
-d '{"name":"USERNAME","value":"octocat"}'Response
Status: 204Delete an environment variable
Deletes an environment variable using the variable name.
You must authenticate using an access token with the repo scope to use this endpoint.
GitHub Apps must have the environment:write repository permission to use this endpoint.
“Delete an environment variable”的参数
| 标头 |
|---|
| 名称, 类型, 说明 |
accept string Setting to |
| 路径参数 |
| 名称, 类型, 说明 |
repository_id integer 必选The unique identifier of the repository. |
name string 必选The name of the variable. |
environment_name string 必选The name of the environment. |
“Delete an environment variable”的 HTTP 响应状态代码
| 状态代码 | 说明 |
|---|---|
204 | No Content |
“Delete an environment variable”的示例代码
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/repositories/REPOSITORY_ID/environments/ENVIRONMENT_NAME/variables/NAMEResponse
Status: 204