Variáveis do GitHub Actions
Use a API REST para interagir com variáveis no GitHub Actions.
Sobre variáveis no GitHub Actions
Você pode usar a API REST para criar, atualizar, excluir e recuperar informações sobre variáveis que podem ser usadas em fluxos de trabalho no GitHub Actions. As variáveis permitem que você armazene informações não confidenciais, como nome de usuário, em seu repositório, ambientes do repositório ou organização. Para obter mais informações, consulte "Variáveis" na documentação do GitHub Actions.
List organization variables
Lists all organization variables.
You must authenticate using an access token with the admin:org
scope to use this endpoint. If the repository is private, you must use an access token with the repo
scope. GitHub Apps must have the organization_actions_variables:read
organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "List organization variables"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
Nome, Type, Descrição |
---|
per_page integer The number of results per page (max 30). Padrão: |
page integer Page number of the results to fetch. Padrão: |
Códigos de status de resposta HTTP para "List organization variables"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "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/variables
Response
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.
If the repository is private, you must use an access token with the repo
scope.
GitHub Apps must have the organization_actions_variables:write
organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Create an organization variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
Nome, Type, Descrição |
---|
name string ObrigatórioThe name of the variable. |
value string ObrigatórioThe value of the variable. |
visibility string ObrigatórioThe type of repositories in the organization that can access the variable. Pode ser um dos: |
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 |
Códigos de status de resposta HTTP para "Create an organization variable"
Código de status | Descrição |
---|---|
201 | Response when creating a variable |
Exemplos de código para "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: 201
Get 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.
If the repository is private, you must use an access token with the repo
scope.
GitHub Apps must have the organization_actions_variables:read
organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Get an organization variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
name string ObrigatórioThe name of the variable. |
Códigos de status de resposta HTTP para "Get an organization variable"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "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/NAME
Response
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.
If the repository is private, you must use an access token with the repo
scope.
GitHub Apps must have the organization_actions_variables:write
organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Update an organization variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
name string ObrigatórioThe name of the variable. |
Nome, Type, Descrição |
---|
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. Pode ser um dos: |
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 |
Códigos de status de resposta HTTP para "Update an organization variable"
Código de status | Descrição |
---|---|
204 | No Content |
Exemplos de código para "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: 204
Delete 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.
If the repository is private, you must use an access token with the repo
scope.
GitHub Apps must have the organization_actions_variables:write
organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Delete an organization variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
name string ObrigatórioThe name of the variable. |
Códigos de status de resposta HTTP para "Delete an organization variable"
Código de status | Descrição |
---|---|
204 | No Content |
Exemplos de código para "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/NAME
Response
Status: 204
List 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.
If the repository is private, you must use an access token with the repo
scope.
GitHub Apps must have the organization_actions_variables:read
organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "List selected repositories for an organization variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
name string ObrigatórioThe name of the variable. |
Nome, Type, Descrição |
---|
page integer Page number of the results to fetch. Padrão: |
per_page integer The number of results per page (max 100). Padrão: |
Códigos de status de resposta HTTP para "List selected repositories for an organization variable"
Código de status | Descrição |
---|---|
200 | OK |
409 | Response when the visibility of the variable is not set to |
Exemplos de código para "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/repositories
Response
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.
If the repository is private, you must use an access token with the repo
scope.
GitHub Apps must have the organization_actions_variables:write
organization permission to use this
endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Set selected repositories for an organization variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
name string ObrigatórioThe name of the variable. |
Nome, Type, Descrição |
---|
selected_repository_ids array of integers ObrigatórioThe IDs of the repositories that can access the organization variable. |
Códigos de status de resposta HTTP para "Set selected repositories for an organization variable"
Código de status | Descrição |
---|---|
204 | No Content |
409 | Response when the visibility of the variable is not set to |
Exemplos de código para "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: 204
Add 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.
If the repository is private, you must use an access token with the repo
scope.
GitHub Apps must have the organization_actions_variables:write
organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Add selected repository to an organization variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
name string ObrigatórioThe name of the variable. |
repository_id integer Obrigatório |
Códigos de status de resposta HTTP para "Add selected repository to an organization variable"
Código de status | Descrição |
---|---|
204 | No Content |
409 | Response when the visibility of the variable is not set to |
Exemplos de código para "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_ID
Response
Status: 204
Remove 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.
If the repository is private, you must use an access token with the repo
scope.
GitHub Apps must have the organization_actions_variables:write
organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Remove selected repository from an organization variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
name string ObrigatórioThe name of the variable. |
repository_id integer Obrigatório |
Códigos de status de resposta HTTP para "Remove selected repository from an organization variable"
Código de status | Descrição |
---|---|
204 | No Content |
409 | Response when the visibility of the variable is not set to |
Exemplos de código para "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_ID
Response
Status: 204
List 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.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "List repository organization variables"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository without the |
Nome, Type, Descrição |
---|
per_page integer The number of results per page (max 30). Padrão: |
page integer Page number of the results to fetch. Padrão: |
Códigos de status de resposta HTTP para "List repository organization variables"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "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-variables
Response
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.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "List repository variables"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository without the |
Nome, Type, Descrição |
---|
per_page integer The number of results per page (max 30). Padrão: |
page integer Page number of the results to fetch. Padrão: |
Códigos de status de resposta HTTP para "List repository variables"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "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/variables
Response
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.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Create a repository variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository without the |
Nome, Type, Descrição |
---|
name string ObrigatórioThe name of the variable. |
value string ObrigatórioThe value of the variable. |
Códigos de status de resposta HTTP para "Create a repository variable"
Código de status | Descrição |
---|---|
201 | Created |
Exemplos de código para "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: 201
Get 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.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Get a repository variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository without the |
name string ObrigatórioThe name of the variable. |
Códigos de status de resposta HTTP para "Get a repository variable"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "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/NAME
Response
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.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Update a repository variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository without the |
name string ObrigatórioThe name of the variable. |
Nome, Type, Descrição |
---|
name string The name of the variable. |
value string The value of the variable. |
Códigos de status de resposta HTTP para "Update a repository variable"
Código de status | Descrição |
---|---|
204 | No Content |
Exemplos de código para "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: 204
Delete 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.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Delete a repository variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository without the |
name string ObrigatórioThe name of the variable. |
Códigos de status de resposta HTTP para "Delete a repository variable"
Código de status | Descrição |
---|---|
204 | No Content |
Exemplos de código para "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/NAME
Response
Status: 204
List 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.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "List environment variables"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
repository_id integer ObrigatórioThe unique identifier of the repository. |
environment_name string ObrigatórioThe name of the environment. |
Nome, Type, Descrição |
---|
per_page integer The number of results per page (max 30). Padrão: |
page integer Page number of the results to fetch. Padrão: |
Códigos de status de resposta HTTP para "List environment variables"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "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/variables
Response
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.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Create an environment variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
repository_id integer ObrigatórioThe unique identifier of the repository. |
environment_name string ObrigatórioThe name of the environment. |
Nome, Type, Descrição |
---|
name string ObrigatórioThe name of the variable. |
value string ObrigatórioThe value of the variable. |
Códigos de status de resposta HTTP para "Create an environment variable"
Código de status | Descrição |
---|---|
201 | Created |
Exemplos de código para "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: 201
Get 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.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Get an environment variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
repository_id integer ObrigatórioThe unique identifier of the repository. |
environment_name string ObrigatórioThe name of the environment. |
name string ObrigatórioThe name of the variable. |
Códigos de status de resposta HTTP para "Get an environment variable"
Código de status | Descrição |
---|---|
200 | OK |
Exemplos de código para "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/NAME
Response
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.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Update an environment variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
repository_id integer ObrigatórioThe unique identifier of the repository. |
name string ObrigatórioThe name of the variable. |
environment_name string ObrigatórioThe name of the environment. |
Nome, Type, Descrição |
---|
name string The name of the variable. |
value string The value of the variable. |
Códigos de status de resposta HTTP para "Update an environment variable"
Código de status | Descrição |
---|---|
204 | No Content |
Exemplos de código para "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: 204
Delete 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.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
Parâmetros para "Delete an environment variable"
Nome, Type, Descrição |
---|
accept string Setting to |
Nome, Type, Descrição |
---|
repository_id integer ObrigatórioThe unique identifier of the repository. |
name string ObrigatórioThe name of the variable. |
environment_name string ObrigatórioThe name of the environment. |
Códigos de status de resposta HTTP para "Delete an environment variable"
Código de status | Descrição |
---|---|
204 | No Content |
Exemplos de código para "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/NAME
Response
Status: 204