variables

Overview

Name	variables
Type	Resource
Id	github.actions.variables

Fields

Name	Datatype	Description
name	string	The name of the variable.
updated_at	string	The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
value	string	The value of the variable.
created_at	string	The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.

Methods

Name	Accessible by	Required Params	Description
get_environment_variable	SELECT	environment_name, name, repository_id	Gets a specific variable in an environment. You must authenticate using an access token with the repo 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 environments:read repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.
get_repo_variable	SELECT	name, owner, repo	Gets a specific variable in a repository. You must authenticate using an access token with the repo 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 actions_variables:read repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.
list_environment_variables	SELECT	environment_name, repository_id	Lists all environment variables. You must authenticate using an access token with the repo 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 environments:read repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.
list_repo_variables	SELECT	owner, repo	Lists all repository variables. You must authenticate using an access token with the repo 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 actions_variables:read repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.
create_environment_variable	INSERT	environment_name, repository_id, data__name, data__value	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. If the repository is private, you must use an access token with the repo scope. 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.
create_repo_variable	INSERT	owner, repo, data__name, data__value	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. If the repository is private, you must use an access token with the repo scope. 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.
delete_environment_variable	DELETE	environment_name, name, repository_id	Deletes an environment variable using the variable name. You must authenticate using an access token with the repo 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 environment:write repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.
delete_repo_variable	DELETE	name, owner, repo	Deletes a repository variable using the variable name. You must authenticate using an access token with the repo 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 actions_variables:write repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.
update_environment_variable	EXEC	environment_name, name, repository_id	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. If the repository is private, you must use an access token with the repo scope. 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.
update_repo_variable	EXEC	name, owner, repo	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. If the repository is private, you must use an access token with the repo scope. 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.