Retrieve instance variable details

GET

/api/v4/admin/ci/variables/{key}

Retrieves details of a specified instance-level variable.

Authorizations

http
oauth2

Parameters

Path Parameters

key

required

string

The key of a variable

Responses

200

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

Instance Variable Not Found