Retrieve a single variable

GET

/api/v4/projects/{id}/variables/{key}

• GitLab REST API

Retrieves details of a specified variable. If there are multiple variables with the same key, use filter to select the correct environment_scope.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

One of:

string

string

integer

integer

The ID of a project or URL-encoded NAMESPACE/PROJECT_NAME of the project owned by the authenticated user

key

required

string

The key of a variable

Query Parameters

filter

Available filters: [environment_scope]. Example: filter[environment_scope]=production

object

filter[environment_scope]

string

nullable

The environment scope of a variable

Responses

200

OK

Media type application/json

object

variable_type

string

key

string

value

string

hidden

boolean

protected

boolean

masked

boolean

raw

boolean

environment_scope

string

description

string

Example

{
  "variable_type": "env_var",
  "key": "TEST_VARIABLE_1",
  "value": "TEST_1",
  "environment_scope": "*",
  "description": "This variable is being used for ..."
}

400

Bad Request

404

Variable Not Found