Get an environment variable

GET

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

Gets a specific variable in an environment.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

API method documentation

Parameters

Path Parameters

owner

required

string

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

repo

required

string

The name of the repository without the .git extension. The name is not case sensitive.

environment_name

required

string

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

name

required

string

The name of the variable.

Responses

200

Response

Media type application/json

Actions Variable

object

name

required

The name of the variable.

string

value

required

The value of the variable.

string

created_at

required

The date and time at which the variable was created, in ISO 8601 format’:’ YYYY-MM-DDTHH:MM:SSZ.

string format: date-time

updated_at

required

The date and time at which the variable was last updated, in ISO 8601 format’:’ YYYY-MM-DDTHH:MM:SSZ.

string format: date-time

Examples

Example default

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