@templmf/temp-solf-lmf 0.0.109 → 0.0.111
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package//347/224/237/344/272/247/347/216/257/345/242/203CK/346/211/251/345/256/271/346/255/245/351/252/244052701.docx +0 -0
- package/gitlab-foss-8-17-stable/doc/api/README.md +0 -391
- package/gitlab-foss-8-17-stable/doc/api/access_requests.md +0 -139
- package/gitlab-foss-8-17-stable/doc/api/award_emoji.md +0 -374
- package/gitlab-foss-8-17-stable/doc/api/boards.md +0 -241
- package/gitlab-foss-8-17-stable/doc/api/branches.md +0 -260
- package/gitlab-foss-8-17-stable/doc/api/broadcast_messages.md +0 -154
- package/gitlab-foss-8-17-stable/doc/api/build_triggers.md +0 -118
- package/gitlab-foss-8-17-stable/doc/api/build_variables.md +0 -128
- package/gitlab-foss-8-17-stable/doc/api/builds.md +0 -610
- package/gitlab-foss-8-17-stable/doc/api/ci/README.md +0 -24
- package/gitlab-foss-8-17-stable/doc/api/ci/builds.md +0 -147
- package/gitlab-foss-8-17-stable/doc/api/ci/lint.md +0 -49
- package/gitlab-foss-8-17-stable/doc/api/ci/runners.md +0 -59
- package/gitlab-foss-8-17-stable/doc/api/commits.md +0 -479
- package/gitlab-foss-8-17-stable/doc/api/deploy_key_multiple_projects.md +0 -29
- package/gitlab-foss-8-17-stable/doc/api/deploy_keys.md +0 -216
- package/gitlab-foss-8-17-stable/doc/api/deployments.md +0 -218
- package/gitlab-foss-8-17-stable/doc/api/enviroments.md +0 -121
- package/gitlab-foss-8-17-stable/doc/api/groups.md +0 -484
- package/gitlab-foss-8-17-stable/doc/api/issues.md +0 -856
- package/gitlab-foss-8-17-stable/doc/api/keys.md +0 -46
- package/gitlab-foss-8-17-stable/doc/api/labels.md +0 -257
- package/gitlab-foss-8-17-stable/doc/api/members.md +0 -175
- package/gitlab-foss-8-17-stable/doc/api/merge_requests.md +0 -1158
- package/gitlab-foss-8-17-stable/doc/api/milestones.md +0 -105
- package/gitlab-foss-8-17-stable/doc/api/namespaces.md +0 -70
- package/gitlab-foss-8-17-stable/doc/api/notes.md +0 -407
- package/gitlab-foss-8-17-stable/doc/api/notification_settings.md +0 -177
- package/gitlab-foss-8-17-stable/doc/api/oauth2.md +0 -137
- package/gitlab-foss-8-17-stable/doc/api/pipelines.md +0 -259
- package/gitlab-foss-8-17-stable/doc/api/project_snippets.md +0 -118
- package/gitlab-foss-8-17-stable/doc/api/projects.md +0 -1402
- package/gitlab-foss-8-17-stable/doc/api/repositories.md +0 -200
- package/gitlab-foss-8-17-stable/doc/api/repository_files.md +0 -134
- package/gitlab-foss-8-17-stable/doc/api/runners.md +0 -322
- package/gitlab-foss-8-17-stable/doc/api/services.md +0 -812
- package/gitlab-foss-8-17-stable/doc/api/session.md +0 -56
- package/gitlab-foss-8-17-stable/doc/api/settings.md +0 -126
- package/gitlab-foss-8-17-stable/doc/api/sidekiq_metrics.md +0 -152
- package/gitlab-foss-8-17-stable/doc/api/snippets.md +0 -232
- package/gitlab-foss-8-17-stable/doc/api/system_hooks.md +0 -146
- package/gitlab-foss-8-17-stable/doc/api/tags.md +0 -191
- package/gitlab-foss-8-17-stable/doc/api/templates/gitignores.md +0 -579
- package/gitlab-foss-8-17-stable/doc/api/templates/gitlab_ci_ymls.md +0 -120
- package/gitlab-foss-8-17-stable/doc/api/templates/licenses.md +0 -147
- package/gitlab-foss-8-17-stable/doc/api/todos.md +0 -296
- package/gitlab-foss-8-17-stable/doc/api/users.md +0 -835
- package/gitlab-foss-8-17-stable/doc/api/v3_to_v4.md +0 -14
- package/gitlab-foss-8-17-stable/doc/api/version.md +0 -23
|
@@ -1,216 +0,0 @@
|
|
|
1
|
-
# Deploy Keys
|
|
2
|
-
|
|
3
|
-
## List all deploy keys
|
|
4
|
-
|
|
5
|
-
Get a list of all deploy keys across all projects of the GitLab instance. This endpoint requires admin access.
|
|
6
|
-
|
|
7
|
-
```
|
|
8
|
-
GET /deploy_keys
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/deploy_keys"
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
Example response:
|
|
16
|
-
|
|
17
|
-
```json
|
|
18
|
-
[
|
|
19
|
-
{
|
|
20
|
-
"id": 1,
|
|
21
|
-
"title": "Public key",
|
|
22
|
-
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
|
|
23
|
-
"can_push": false,
|
|
24
|
-
"created_at": "2013-10-02T10:12:29Z"
|
|
25
|
-
},
|
|
26
|
-
{
|
|
27
|
-
"id": 3,
|
|
28
|
-
"title": "Another Public key",
|
|
29
|
-
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
|
|
30
|
-
"can_push": true,
|
|
31
|
-
"created_at": "2013-10-02T11:12:29Z"
|
|
32
|
-
}
|
|
33
|
-
]
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
## List project deploy keys
|
|
37
|
-
|
|
38
|
-
Get a list of a project's deploy keys.
|
|
39
|
-
|
|
40
|
-
```
|
|
41
|
-
GET /projects/:id/deploy_keys
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
| Attribute | Type | Required | Description |
|
|
45
|
-
| --------- | ---- | -------- | ----------- |
|
|
46
|
-
| `id` | integer | yes | The ID of the project |
|
|
47
|
-
|
|
48
|
-
```bash
|
|
49
|
-
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/deploy_keys"
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
Example response:
|
|
53
|
-
|
|
54
|
-
```json
|
|
55
|
-
[
|
|
56
|
-
{
|
|
57
|
-
"id": 1,
|
|
58
|
-
"title": "Public key",
|
|
59
|
-
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
|
|
60
|
-
"can_push": false,
|
|
61
|
-
"created_at": "2013-10-02T10:12:29Z"
|
|
62
|
-
},
|
|
63
|
-
{
|
|
64
|
-
"id": 3,
|
|
65
|
-
"title": "Another Public key",
|
|
66
|
-
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
|
|
67
|
-
"can_push": false,
|
|
68
|
-
"created_at": "2013-10-02T11:12:29Z"
|
|
69
|
-
}
|
|
70
|
-
]
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
## Single deploy key
|
|
74
|
-
|
|
75
|
-
Get a single key.
|
|
76
|
-
|
|
77
|
-
```
|
|
78
|
-
GET /projects/:id/deploy_keys/:key_id
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
Parameters:
|
|
82
|
-
|
|
83
|
-
| Attribute | Type | Required | Description |
|
|
84
|
-
| --------- | ---- | -------- | ----------- |
|
|
85
|
-
| `id` | integer | yes | The ID of the project |
|
|
86
|
-
| `key_id` | integer | yes | The ID of the deploy key |
|
|
87
|
-
|
|
88
|
-
```bash
|
|
89
|
-
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/deploy_keys/11"
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
Example response:
|
|
93
|
-
|
|
94
|
-
```json
|
|
95
|
-
{
|
|
96
|
-
"id": 1,
|
|
97
|
-
"title": "Public key",
|
|
98
|
-
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0=",
|
|
99
|
-
"can_push": false,
|
|
100
|
-
"created_at": "2013-10-02T10:12:29Z"
|
|
101
|
-
}
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
## Add deploy key
|
|
105
|
-
|
|
106
|
-
Creates a new deploy key for a project.
|
|
107
|
-
|
|
108
|
-
If the deploy key already exists in another project, it will be joined to current
|
|
109
|
-
project only if original one was is accessible by the same user.
|
|
110
|
-
|
|
111
|
-
```
|
|
112
|
-
POST /projects/:id/deploy_keys
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
| Attribute | Type | Required | Description |
|
|
116
|
-
| --------- | ---- | -------- | ----------- |
|
|
117
|
-
| `id` | integer | yes | The ID of the project |
|
|
118
|
-
| `title` | string | yes | New deploy key's title |
|
|
119
|
-
| `key` | string | yes | New deploy key |
|
|
120
|
-
| `can_push` | boolean | no | Can deploy key push to the project's repository |
|
|
121
|
-
|
|
122
|
-
```bash
|
|
123
|
-
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --header "Content-Type: application/json" --data '{"title": "My deploy key", "key": "ssh-rsa AAAA...", "can_push": "true"}' "https://gitlab.example.com/api/v3/projects/5/deploy_keys/"
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
Example response:
|
|
127
|
-
|
|
128
|
-
```json
|
|
129
|
-
{
|
|
130
|
-
"key" : "ssh-rsa AAAA...",
|
|
131
|
-
"id" : 12,
|
|
132
|
-
"title" : "My deploy key",
|
|
133
|
-
"can_push": true,
|
|
134
|
-
"created_at" : "2015-08-29T12:44:31.550Z"
|
|
135
|
-
}
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
## Delete deploy key
|
|
139
|
-
|
|
140
|
-
Delete a deploy key from a project
|
|
141
|
-
|
|
142
|
-
```
|
|
143
|
-
DELETE /projects/:id/deploy_keys/:key_id
|
|
144
|
-
```
|
|
145
|
-
|
|
146
|
-
| Attribute | Type | Required | Description |
|
|
147
|
-
| --------- | ---- | -------- | ----------- |
|
|
148
|
-
| `id` | integer | yes | The ID of the project |
|
|
149
|
-
| `key_id` | integer | yes | The ID of the deploy key |
|
|
150
|
-
|
|
151
|
-
```bash
|
|
152
|
-
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/deploy_keys/13"
|
|
153
|
-
```
|
|
154
|
-
|
|
155
|
-
Example response:
|
|
156
|
-
|
|
157
|
-
```json
|
|
158
|
-
{
|
|
159
|
-
"updated_at" : "2015-08-29T12:50:57.259Z",
|
|
160
|
-
"key" : "ssh-rsa AAAA...",
|
|
161
|
-
"public" : false,
|
|
162
|
-
"title" : "My deploy key",
|
|
163
|
-
"user_id" : null,
|
|
164
|
-
"created_at" : "2015-08-29T12:50:57.259Z",
|
|
165
|
-
"fingerprint" : "6a:33:1f:74:51:c0:39:81:79:ec:7a:31:f8:40:20:43",
|
|
166
|
-
"id" : 13
|
|
167
|
-
}
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
## Enable a deploy key
|
|
171
|
-
|
|
172
|
-
Enables a deploy key for a project so this can be used. Returns the enabled key, with a status code 201 when successful.
|
|
173
|
-
|
|
174
|
-
```bash
|
|
175
|
-
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/deploy_keys/13/enable
|
|
176
|
-
```
|
|
177
|
-
|
|
178
|
-
| Attribute | Type | Required | Description |
|
|
179
|
-
| --------- | ---- | -------- | ----------- |
|
|
180
|
-
| `id` | integer | yes | The ID of the project |
|
|
181
|
-
| `key_id` | integer | yes | The ID of the deploy key |
|
|
182
|
-
|
|
183
|
-
Example response:
|
|
184
|
-
|
|
185
|
-
```json
|
|
186
|
-
{
|
|
187
|
-
"key" : "ssh-rsa AAAA...",
|
|
188
|
-
"id" : 12,
|
|
189
|
-
"title" : "My deploy key",
|
|
190
|
-
"created_at" : "2015-08-29T12:44:31.550Z"
|
|
191
|
-
}
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
## Disable a deploy key
|
|
195
|
-
|
|
196
|
-
Disable a deploy key for a project. Returns the disabled key.
|
|
197
|
-
|
|
198
|
-
```bash
|
|
199
|
-
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/deploy_keys/13/disable
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
| Attribute | Type | Required | Description |
|
|
203
|
-
| --------- | ---- | -------- | ----------- |
|
|
204
|
-
| `id` | integer | yes | The ID of the project |
|
|
205
|
-
| `key_id` | integer | yes | The ID of the deploy key |
|
|
206
|
-
|
|
207
|
-
Example response:
|
|
208
|
-
|
|
209
|
-
```json
|
|
210
|
-
{
|
|
211
|
-
"key" : "ssh-rsa AAAA...",
|
|
212
|
-
"id" : 12,
|
|
213
|
-
"title" : "My deploy key",
|
|
214
|
-
"created_at" : "2015-08-29T12:44:31.550Z"
|
|
215
|
-
}
|
|
216
|
-
```
|
|
@@ -1,218 +0,0 @@
|
|
|
1
|
-
# Deployments API
|
|
2
|
-
|
|
3
|
-
## List project deployments
|
|
4
|
-
|
|
5
|
-
Get a list of deployments in a project.
|
|
6
|
-
|
|
7
|
-
```
|
|
8
|
-
GET /projects/:id/deployments
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
| Attribute | Type | Required | Description |
|
|
12
|
-
|-----------|---------|----------|---------------------|
|
|
13
|
-
| `id` | integer | yes | The ID of a project |
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/deployments"
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
Example of response
|
|
20
|
-
|
|
21
|
-
```json
|
|
22
|
-
[
|
|
23
|
-
{
|
|
24
|
-
"created_at": "2016-08-11T07:36:40.222Z",
|
|
25
|
-
"deployable": {
|
|
26
|
-
"commit": {
|
|
27
|
-
"author_email": "admin@example.com",
|
|
28
|
-
"author_name": "Administrator",
|
|
29
|
-
"created_at": "2016-08-11T09:36:01.000+02:00",
|
|
30
|
-
"id": "99d03678b90d914dbb1b109132516d71a4a03ea8",
|
|
31
|
-
"message": "Merge branch 'new-title' into 'master'\r\n\r\nUpdate README\r\n\r\n\r\n\r\nSee merge request !1",
|
|
32
|
-
"short_id": "99d03678",
|
|
33
|
-
"title": "Merge branch 'new-title' into 'master'\r"
|
|
34
|
-
},
|
|
35
|
-
"coverage": null,
|
|
36
|
-
"created_at": "2016-08-11T07:36:27.357Z",
|
|
37
|
-
"finished_at": "2016-08-11T07:36:39.851Z",
|
|
38
|
-
"id": 657,
|
|
39
|
-
"name": "deploy",
|
|
40
|
-
"ref": "master",
|
|
41
|
-
"runner": null,
|
|
42
|
-
"stage": "deploy",
|
|
43
|
-
"started_at": null,
|
|
44
|
-
"status": "success",
|
|
45
|
-
"tag": false,
|
|
46
|
-
"user": {
|
|
47
|
-
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
|
|
48
|
-
"bio": null,
|
|
49
|
-
"created_at": "2016-08-11T07:09:20.351Z",
|
|
50
|
-
"id": 1,
|
|
51
|
-
"is_admin": true,
|
|
52
|
-
"linkedin": "",
|
|
53
|
-
"location": null,
|
|
54
|
-
"name": "Administrator",
|
|
55
|
-
"skype": "",
|
|
56
|
-
"state": "active",
|
|
57
|
-
"twitter": "",
|
|
58
|
-
"username": "root",
|
|
59
|
-
"web_url": "http://localhost:3000/root",
|
|
60
|
-
"website_url": ""
|
|
61
|
-
}
|
|
62
|
-
},
|
|
63
|
-
"environment": {
|
|
64
|
-
"external_url": "https://about.gitlab.com",
|
|
65
|
-
"id": 9,
|
|
66
|
-
"name": "production"
|
|
67
|
-
},
|
|
68
|
-
"id": 41,
|
|
69
|
-
"iid": 1,
|
|
70
|
-
"ref": "master",
|
|
71
|
-
"sha": "99d03678b90d914dbb1b109132516d71a4a03ea8",
|
|
72
|
-
"user": {
|
|
73
|
-
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
|
|
74
|
-
"id": 1,
|
|
75
|
-
"name": "Administrator",
|
|
76
|
-
"state": "active",
|
|
77
|
-
"username": "root",
|
|
78
|
-
"web_url": "http://localhost:3000/root"
|
|
79
|
-
}
|
|
80
|
-
},
|
|
81
|
-
{
|
|
82
|
-
"created_at": "2016-08-11T11:32:35.444Z",
|
|
83
|
-
"deployable": {
|
|
84
|
-
"commit": {
|
|
85
|
-
"author_email": "admin@example.com",
|
|
86
|
-
"author_name": "Administrator",
|
|
87
|
-
"created_at": "2016-08-11T13:28:26.000+02:00",
|
|
88
|
-
"id": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
|
|
89
|
-
"message": "Merge branch 'rename-readme' into 'master'\r\n\r\nRename README\r\n\r\n\r\n\r\nSee merge request !2",
|
|
90
|
-
"short_id": "a91957a8",
|
|
91
|
-
"title": "Merge branch 'rename-readme' into 'master'\r"
|
|
92
|
-
},
|
|
93
|
-
"coverage": null,
|
|
94
|
-
"created_at": "2016-08-11T11:32:24.456Z",
|
|
95
|
-
"finished_at": "2016-08-11T11:32:35.145Z",
|
|
96
|
-
"id": 664,
|
|
97
|
-
"name": "deploy",
|
|
98
|
-
"ref": "master",
|
|
99
|
-
"runner": null,
|
|
100
|
-
"stage": "deploy",
|
|
101
|
-
"started_at": null,
|
|
102
|
-
"status": "success",
|
|
103
|
-
"tag": false,
|
|
104
|
-
"user": {
|
|
105
|
-
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
|
|
106
|
-
"bio": null,
|
|
107
|
-
"created_at": "2016-08-11T07:09:20.351Z",
|
|
108
|
-
"id": 1,
|
|
109
|
-
"is_admin": true,
|
|
110
|
-
"linkedin": "",
|
|
111
|
-
"location": null,
|
|
112
|
-
"name": "Administrator",
|
|
113
|
-
"skype": "",
|
|
114
|
-
"state": "active",
|
|
115
|
-
"twitter": "",
|
|
116
|
-
"username": "root",
|
|
117
|
-
"web_url": "http://localhost:3000/root",
|
|
118
|
-
"website_url": ""
|
|
119
|
-
}
|
|
120
|
-
},
|
|
121
|
-
"environment": {
|
|
122
|
-
"external_url": "https://about.gitlab.com",
|
|
123
|
-
"id": 9,
|
|
124
|
-
"name": "production"
|
|
125
|
-
},
|
|
126
|
-
"id": 42,
|
|
127
|
-
"iid": 2,
|
|
128
|
-
"ref": "master",
|
|
129
|
-
"sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
|
|
130
|
-
"user": {
|
|
131
|
-
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
|
|
132
|
-
"id": 1,
|
|
133
|
-
"name": "Administrator",
|
|
134
|
-
"state": "active",
|
|
135
|
-
"username": "root",
|
|
136
|
-
"web_url": "http://localhost:3000/root"
|
|
137
|
-
}
|
|
138
|
-
}
|
|
139
|
-
]
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
## Get a specific deployment
|
|
143
|
-
|
|
144
|
-
```
|
|
145
|
-
GET /projects/:id/deployments/:deployment_id
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
| Attribute | Type | Required | Description |
|
|
149
|
-
|-----------|---------|----------|---------------------|
|
|
150
|
-
| `id` | integer | yes | The ID of a project |
|
|
151
|
-
| `deployment_id` | integer | yes | The ID of the deployment |
|
|
152
|
-
|
|
153
|
-
```bash
|
|
154
|
-
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/deployments/1"
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
Example of response
|
|
158
|
-
|
|
159
|
-
```json
|
|
160
|
-
{
|
|
161
|
-
"id": 42,
|
|
162
|
-
"iid": 2,
|
|
163
|
-
"ref": "master",
|
|
164
|
-
"sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
|
|
165
|
-
"created_at": "2016-08-11T11:32:35.444Z",
|
|
166
|
-
"user": {
|
|
167
|
-
"name": "Administrator",
|
|
168
|
-
"username": "root",
|
|
169
|
-
"id": 1,
|
|
170
|
-
"state": "active",
|
|
171
|
-
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
|
|
172
|
-
"web_url": "http://localhost:3000/root"
|
|
173
|
-
},
|
|
174
|
-
"environment": {
|
|
175
|
-
"id": 9,
|
|
176
|
-
"name": "production",
|
|
177
|
-
"external_url": "https://about.gitlab.com"
|
|
178
|
-
},
|
|
179
|
-
"deployable": {
|
|
180
|
-
"id": 664,
|
|
181
|
-
"status": "success",
|
|
182
|
-
"stage": "deploy",
|
|
183
|
-
"name": "deploy",
|
|
184
|
-
"ref": "master",
|
|
185
|
-
"tag": false,
|
|
186
|
-
"coverage": null,
|
|
187
|
-
"created_at": "2016-08-11T11:32:24.456Z",
|
|
188
|
-
"started_at": null,
|
|
189
|
-
"finished_at": "2016-08-11T11:32:35.145Z",
|
|
190
|
-
"user": {
|
|
191
|
-
"name": "Administrator",
|
|
192
|
-
"username": "root",
|
|
193
|
-
"id": 1,
|
|
194
|
-
"state": "active",
|
|
195
|
-
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
|
|
196
|
-
"web_url": "http://localhost:3000/root",
|
|
197
|
-
"created_at": "2016-08-11T07:09:20.351Z",
|
|
198
|
-
"is_admin": true,
|
|
199
|
-
"bio": null,
|
|
200
|
-
"location": null,
|
|
201
|
-
"skype": "",
|
|
202
|
-
"linkedin": "",
|
|
203
|
-
"twitter": "",
|
|
204
|
-
"website_url": ""
|
|
205
|
-
},
|
|
206
|
-
"commit": {
|
|
207
|
-
"id": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
|
|
208
|
-
"short_id": "a91957a8",
|
|
209
|
-
"title": "Merge branch 'rename-readme' into 'master'\r",
|
|
210
|
-
"author_name": "Administrator",
|
|
211
|
-
"author_email": "admin@example.com",
|
|
212
|
-
"created_at": "2016-08-11T13:28:26.000+02:00",
|
|
213
|
-
"message": "Merge branch 'rename-readme' into 'master'\r\n\r\nRename README\r\n\r\n\r\n\r\nSee merge request !2"
|
|
214
|
-
},
|
|
215
|
-
"runner": null
|
|
216
|
-
}
|
|
217
|
-
}
|
|
218
|
-
```
|
|
@@ -1,121 +0,0 @@
|
|
|
1
|
-
# Environments
|
|
2
|
-
|
|
3
|
-
## List environments
|
|
4
|
-
|
|
5
|
-
Get all environments for a given project.
|
|
6
|
-
|
|
7
|
-
```
|
|
8
|
-
GET /projects/:id/environments
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
| Attribute | Type | Required | Description |
|
|
12
|
-
| --------- | ------- | -------- | --------------------- |
|
|
13
|
-
| `id` | integer | yes | The ID of the project |
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/1/environments
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
Example response:
|
|
20
|
-
|
|
21
|
-
```json
|
|
22
|
-
[
|
|
23
|
-
{
|
|
24
|
-
"id": 1,
|
|
25
|
-
"name": "review/fix-foo",
|
|
26
|
-
"slug": "review-fix-foo-dfjre3",
|
|
27
|
-
"external_url": "https://review-fix-foo-dfjre3.example.gitlab.com"
|
|
28
|
-
}
|
|
29
|
-
]
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
## Create a new environment
|
|
33
|
-
|
|
34
|
-
Creates a new environment with the given name and external_url.
|
|
35
|
-
|
|
36
|
-
It returns 201 if the environment was successfully created, 400 for wrong parameters.
|
|
37
|
-
|
|
38
|
-
```
|
|
39
|
-
POST /projects/:id/environment
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
| Attribute | Type | Required | Description |
|
|
43
|
-
| ------------- | ------- | -------- | ---------------------------- |
|
|
44
|
-
| `id` | integer | yes | The ID of the project |
|
|
45
|
-
| `name` | string | yes | The name of the environment |
|
|
46
|
-
| `external_url` | string | no | Place to link to for this environment |
|
|
47
|
-
|
|
48
|
-
```bash
|
|
49
|
-
curl --data "name=deploy&external_url=https://deploy.example.gitlab.com" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/environments"
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
Example response:
|
|
53
|
-
|
|
54
|
-
```json
|
|
55
|
-
{
|
|
56
|
-
"id": 1,
|
|
57
|
-
"name": "deploy",
|
|
58
|
-
"slug": "deploy",
|
|
59
|
-
"external_url": "https://deploy.example.gitlab.com"
|
|
60
|
-
}
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
## Edit an existing environment
|
|
64
|
-
|
|
65
|
-
Updates an existing environment's name and/or external_url.
|
|
66
|
-
|
|
67
|
-
It returns 200 if the environment was successfully updated. In case of an error, a status code 400 is returned.
|
|
68
|
-
|
|
69
|
-
```
|
|
70
|
-
PUT /projects/:id/environments/:environments_id
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
| Attribute | Type | Required | Description |
|
|
74
|
-
| --------------- | ------- | --------------------------------- | ------------------------------- |
|
|
75
|
-
| `id` | integer | yes | The ID of the project |
|
|
76
|
-
| `environment_id` | integer | yes | The ID of the environment | The ID of the environment |
|
|
77
|
-
| `name` | string | no | The new name of the environment |
|
|
78
|
-
| `external_url` | string | no | The new external_url |
|
|
79
|
-
|
|
80
|
-
```bash
|
|
81
|
-
curl --request PUT --data "name=staging&external_url=https://staging.example.gitlab.com" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/environments/1"
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
Example response:
|
|
85
|
-
|
|
86
|
-
```json
|
|
87
|
-
{
|
|
88
|
-
"id": 1,
|
|
89
|
-
"name": "staging",
|
|
90
|
-
"slug": "staging",
|
|
91
|
-
"external_url": "https://staging.example.gitlab.com"
|
|
92
|
-
}
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
## Delete an environment
|
|
96
|
-
|
|
97
|
-
It returns 200 if the environment was successfully deleted, and 404 if the environment does not exist.
|
|
98
|
-
|
|
99
|
-
```
|
|
100
|
-
DELETE /projects/:id/environments/:environment_id
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
| Attribute | Type | Required | Description |
|
|
104
|
-
| --------- | ------- | -------- | --------------------- |
|
|
105
|
-
| `id` | integer | yes | The ID of the project |
|
|
106
|
-
| `environment_id` | integer | yes | The ID of the environment |
|
|
107
|
-
|
|
108
|
-
```bash
|
|
109
|
-
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/environments/1"
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
Example response:
|
|
113
|
-
|
|
114
|
-
```json
|
|
115
|
-
{
|
|
116
|
-
"id": 1,
|
|
117
|
-
"name": "deploy",
|
|
118
|
-
"slug": "deploy",
|
|
119
|
-
"external_url": "https://deploy.example.gitlab.com"
|
|
120
|
-
}
|
|
121
|
-
```
|