kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/api/build_variables.md
Robert Schilling 1ead6a9793 Use v4 endpoint in API docs
2017-03-01 18:39:40 +01:00

2.9 KiB
Raw Blame History

Build Variables

List project variables

Get list of a project's build variables.

GET /projects/:id/variables
Attribute Type required Description
id integer yes The ID of a project 
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/variables"

[
    {
        "key": "TEST_VARIABLE_1",
        "value": "TEST_1"
    },
    {
        "key": "TEST_VARIABLE_2",
        "value": "TEST_2"
    }
]

Show variable details

Get the details of a project's specific build variable.

GET /projects/:id/variables/:key
Attribute Type required Description
id integer yes The ID of a project
key string yes The key of a variable 
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/variables/TEST_VARIABLE_1"

{
    "key": "TEST_VARIABLE_1",
    "value": "TEST_1"
}

Create variable

Create a new build variable.

POST /projects/:id/variables
Attribute Type required Description
id integer yes The ID of a project
key string yes The key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed
value string yes The value of a variable 
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/variables" --form "key=NEW_VARIABLE" --form "value=new value"

{
    "key": "NEW_VARIABLE",
    "value": "new value"
}

Update variable

Update a project's build variable.

PUT /projects/:id/variables/:key
Attribute Type required Description
id integer yes The ID of a project
key string yes The key of a variable
value string yes The value of a variable 
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/variables/NEW_VARIABLE" --form "value=updated value"

{
    "key": "NEW_VARIABLE",
    "value": "updated value"
}

Remove variable

Remove a project's build variable.

DELETE /projects/:id/variables/:key
Attribute Type required Description
id integer yes The ID of a project
key string yes The key of a variable 
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/variables/VARIABLE_1"