summaryrefslogtreecommitdiff
path: root/doc/api/build_variables.md
blob: 2b804fd90516ab1d6651be62efa8ee7b7cd90237 (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
# Build Variables

## Variables keys

All variable keys must contains only letters, digits and '\_'. They must also be no longer than 255 characters.

## List project variables

Get list of variables of a project.

```
GET /projects/:id/variables
```

Parameters:

- `id` (required) - The ID of a project

```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:

- `id` (required) - The ID of a project
- `key` (required) - The `key` of variable

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

## Create variable

Create new variable in project.

```
POST /projects/:id/variables
```

Parameters:

- `id` (required) - The ID of a project
- `key` (required) - The `key` for variable
- `value` (required) - The `value` for variable

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

## Update variable

Update variable.

```
PUT /projects/:id/variables/:key
```

Parameters:

- `id` (required) - The ID of a project
- `key` (required) - The `key` for variable
- `value` (required) - The `value` for variable

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

## Remove variable

Remove variable.

```
DELETE /projects/:id/variables/:key
```

Parameters:

- `id` (required) - The ID of a project
- `key` (required) - The `key` for variable