Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.
All products
API REST
The REST API is now versioned. For more information, see "About API versioning."

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.

Esses pontos de extremidade estão disponíveis para usuários autenticados, OAuth Apps e GitHub Apps. Os tokens de acesso exigem o escopo repo para repositórios privados e o escopo public_repo para repositórios públicos.Os GitHub Apps precisam ter a permissão actions_variables/environments/organization_actions_variables para usar esses pontos de extremidade. Os usuários autenticados devem ter acesso de colaborador em um repositório para criar, atualizar ou ler variáveis.

List organization variables

Works with GitHub Apps

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.

Parameters for "List organization variables"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringRequired

The organization name. The name is not case sensitive.

Query parameters
per_pageinteger

The number of results per page (max 30).

Default: 10

pageinteger

Page number of the results to fetch.

Default: 1

HTTP response status codes for "List organization variables"

Status codeDescription
200

OK

Code samples for "List organization variables"

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

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

Works with GitHub Apps

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.

Parameters for "Create an organization variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringRequired

The organization name. The name is not case sensitive.

Body parameters
namestringRequired

The name of the variable.

valuestringRequired

The value of the variable.

visibilitystringRequired

The type of repositories in the organization that can access the variable. selected means only the repositories specified by selected_repository_ids can access the variable.

Can be one of: all, private, selected

selected_repository_idsarray of integers

An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the visibility is set to selected.

HTTP response status codes for "Create an organization variable"

Status codeDescription
201

Response when creating a variable

Code samples for "Create an organization variable"

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]}'

Response when creating a variable

Status: 201

Get an organization variable

Works with GitHub Apps

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.

Parameters for "Get an organization variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringRequired

The organization name. The name is not case sensitive.

namestringRequired

The name of the variable.

HTTP response status codes for "Get an organization variable"

Status codeDescription
200

OK

Code samples for "Get an organization variable"

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

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

Works with GitHub Apps

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.

Parameters for "Update an organization variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringRequired

The organization name. The name is not case sensitive.

namestringRequired

The name of the variable.

Body parameters
namestring

The name of the variable.

valuestring

The value of the variable.

visibilitystring

The type of repositories in the organization that can access the variable. selected means only the repositories specified by selected_repository_ids can access the variable.

Can be one of: all, private, selected

selected_repository_idsarray of integers

An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the visibility is set to selected.

HTTP response status codes for "Update an organization variable"

Status codeDescription
204

No Content

Code samples for "Update an organization variable"

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]}'

Response

Status: 204

Delete an organization variable

Works with GitHub Apps

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.

Parameters for "Delete an organization variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringRequired

The organization name. The name is not case sensitive.

namestringRequired

The name of the variable.

HTTP response status codes for "Delete an organization variable"

Status codeDescription
204

No Content

Code samples for "Delete an organization variable"

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

Response

Status: 204

List selected repositories for an organization variable

Works with GitHub Apps

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.

Parameters for "List selected repositories for an organization variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringRequired

The organization name. The name is not case sensitive.

namestringRequired

The name of the variable.

Query parameters
pageinteger

Page number of the results to fetch.

Default: 1

per_pageinteger

The number of results per page (max 100).

Default: 30

HTTP response status codes for "List selected repositories for an organization variable"

Status codeDescription
200

OK

409

Response when the visibility of the variable is not set to selected

Code samples for "List selected repositories for an organization variable"

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

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

Works with GitHub Apps

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.

Parameters for "Set selected repositories for an organization variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringRequired

The organization name. The name is not case sensitive.

namestringRequired

The name of the variable.

Body parameters
selected_repository_idsarray of integersRequired

The IDs of the repositories that can access the organization variable.

HTTP response status codes for "Set selected repositories for an organization variable"

Status codeDescription
204

No Content

409

Response when the visibility of the variable is not set to selected

Code samples for "Set selected repositories for an organization variable"

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]}'

Response

Status: 204

Add selected repository to an organization variable

Works with GitHub Apps

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.

Parameters for "Add selected repository to an organization variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringRequired

The organization name. The name is not case sensitive.

namestringRequired

The name of the variable.

repository_idintegerRequired

HTTP response status codes for "Add selected repository to an organization variable"

Status codeDescription
204

No Content

409

Response when the visibility of the variable is not set to selected

Code samples for "Add selected repository to an organization variable"

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

Response

Status: 204

Remove selected repository from an organization variable

Works with GitHub Apps

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.

Parameters for "Remove selected repository from an organization variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
orgstringRequired

The organization name. The name is not case sensitive.

namestringRequired

The name of the variable.

repository_idintegerRequired

HTTP response status codes for "Remove selected repository from an organization variable"

Status codeDescription
204

No Content

409

Response when the visibility of the variable is not set to selected

Code samples for "Remove selected repository from an organization variable"

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

Response

Status: 204

List repository variables

Works with GitHub Apps

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.

Parameters for "List repository variables"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
ownerstringRequired

The account owner of the repository. The name is not case sensitive.

repostringRequired

The name of the repository. The name is not case sensitive.

Query parameters
per_pageinteger

The number of results per page (max 30).

Default: 10

pageinteger

Page number of the results to fetch.

Default: 1

HTTP response status codes for "List repository variables"

Status codeDescription
200

OK

Code samples for "List repository variables"

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

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

Works with GitHub Apps

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.

Parameters for "Create a repository variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
ownerstringRequired

The account owner of the repository. The name is not case sensitive.

repostringRequired

The name of the repository. The name is not case sensitive.

Body parameters
namestringRequired

The name of the variable.

valuestringRequired

The value of the variable.

HTTP response status codes for "Create a repository variable"

Status codeDescription
201

Created

Code samples for "Create a repository variable"

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"}'

Response

Status: 201

Get a repository variable

Works with GitHub Apps

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.

Parameters for "Get a repository variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
ownerstringRequired

The account owner of the repository. The name is not case sensitive.

repostringRequired

The name of the repository. The name is not case sensitive.

namestringRequired

The name of the variable.

HTTP response status codes for "Get a repository variable"

Status codeDescription
200

OK

Code samples for "Get a repository variable"

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

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

Works with GitHub Apps

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.

Parameters for "Update a repository variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
ownerstringRequired

The account owner of the repository. The name is not case sensitive.

repostringRequired

The name of the repository. The name is not case sensitive.

namestringRequired

The name of the variable.

Body parameters
namestring

The name of the variable.

valuestring

The value of the variable.

HTTP response status codes for "Update a repository variable"

Status codeDescription
204

No Content

Code samples for "Update a repository variable"

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"}'

Response

Status: 204

Delete a repository variable

Works with GitHub Apps

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.

Parameters for "Delete a repository variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
ownerstringRequired

The account owner of the repository. The name is not case sensitive.

repostringRequired

The name of the repository. The name is not case sensitive.

namestringRequired

The name of the variable.

HTTP response status codes for "Delete a repository variable"

Status codeDescription
204

No Content

Code samples for "Delete a repository variable"

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

Response

Status: 204

List environment variables

Works with GitHub Apps

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.

Parameters for "List environment variables"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
repository_idintegerRequired

The unique identifier of the repository.

environment_namestringRequired

The name of the environment.

Query parameters
per_pageinteger

The number of results per page (max 30).

Default: 10

pageinteger

Page number of the results to fetch.

Default: 1

HTTP response status codes for "List environment variables"

Status codeDescription
200

OK

Code samples for "List environment variables"

get/repositories/{repository_id}/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/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

Works with GitHub Apps

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.

Parameters for "Create an environment variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
repository_idintegerRequired

The unique identifier of the repository.

environment_namestringRequired

The name of the environment.

Body parameters
namestringRequired

The name of the variable.

valuestringRequired

The value of the variable.

HTTP response status codes for "Create an environment variable"

Status codeDescription
201

Created

Code samples for "Create an environment variable"

post/repositories/{repository_id}/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/repositories/REPOSITORY_ID/environments/ENVIRONMENT_NAME/variables \ -d '{"name":"USERNAME","value":"octocat"}'

Response

Status: 201

Get an environment variable

Works with GitHub Apps

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.

Parameters for "Get an environment variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
repository_idintegerRequired

The unique identifier of the repository.

environment_namestringRequired

The name of the environment.

namestringRequired

The name of the variable.

HTTP response status codes for "Get an environment variable"

Status codeDescription
200

OK

Code samples for "Get an environment variable"

get/repositories/{repository_id}/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/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

Works with GitHub Apps

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.

Parameters for "Update an environment variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
repository_idintegerRequired

The unique identifier of the repository.

namestringRequired

The name of the variable.

environment_namestringRequired

The name of the environment.

Body parameters
namestring

The name of the variable.

valuestring

The value of the variable.

HTTP response status codes for "Update an environment variable"

Status codeDescription
204

No Content

Code samples for "Update an environment variable"

patch/repositories/{repository_id}/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/repositories/REPOSITORY_ID/environments/ENVIRONMENT_NAME/variables/NAME \ -d '{"name":"USERNAME","value":"octocat"}'

Response

Status: 204

Delete an environment variable

Works with GitHub Apps

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.

Parameters for "Delete an environment variable"

Headers
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
repository_idintegerRequired

The unique identifier of the repository.

namestringRequired

The name of the variable.

environment_namestringRequired

The name of the environment.

HTTP response status codes for "Delete an environment variable"

Status codeDescription
204

No Content

Code samples for "Delete an environment variable"

delete/repositories/{repository_id}/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/repositories/REPOSITORY_ID/environments/ENVIRONMENT_NAME/variables/NAME

Response

Status: 204