blob: 5da5fb8f4a6efd7800eeb04f5b824d4afe2da64d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
# Build Variables
## List project variables
Get list of variables of a project.
```
GET /projects/:id/variables
```
### Parameters
| Attribute | Type | required | Description |
|-----------|---------|----------|---------------------|
| id | integer | yes | The ID of a project |
### Example of request
```
curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/variables"
```
### Example of response
```json
[
{
"key": "TEST_VARIABLE_1",
"value": "TEST_1"
},
{
"key": "TEST_VARIABLE_2",
"value": "TEST_2"
}
]
```
## Show variable details
Get details of specifica variable of a project.
```
GET /projects/:id/variables/:key
```
### Parameters
| Attribute | Type | required | Description |
|-----------|---------|----------|-----------------------|
| id | integer | yes | The ID of a project |
| key | string | yes | The `key` of variable |
### Example of request
```
curl -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/variables/TEST_VARIABLE_1"
```
### Example of response
```json
{
"key": "TEST_VARIABLE_1",
"value": "TEST_1"
}
```
## Create variable
Create new variable in project.
```
POST /projects/:id/variables
```
### Parameters
| Attribute | Type | required | Description |
|-----------|---------|----------|-----------------------|
| id | integer | yes | The ID of a project |
| key | string | yes | The `key` of variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9`, and `_` are allowed |
| value | string | yes | The `value` of variable |
### Example of request
```
curl -X POST -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/variables" -F "key=NEW_VARIABLE" -F "value=new value"
```
### Example of response
```json
{
"key": "NEW_VARIABLE",
"value": "new value"
}
```
## Update variable
Update variable.
```
PUT /projects/:id/variables/:key
```
### Parameters
| Attribute | Type | required | Description |
|-----------|---------|----------|-------------------------|
| id | integer | yes | The ID of a project |
| key | string | yes | The `key` of variable |
| value | string | yes | The `value` of variable |
### Example of request
```
curl -X PUT -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/variables/NEW_VARIABLE" -F "value=updated value"
```
### Example of response
```json
{
"key": "NEW_VARIABLE",
"value": "updated value"
}
```
## Remove variable
Remove variable.
```
DELETE /projects/:id/variables/:key
```
### Parameters
| Attribute | Type | required | Description |
|-----------|---------|----------|-------------------------|
| id | integer | yes | The ID of a project |
| key | string | yes | The `key` of variable |
### Example of request
```
curl -X DELETE -H "PRIVATE_TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/variables/VARIABLE_1"
```
|
