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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
# Projects API
This API is intended to aid in the setup and configuration of
projects on Gitlab CI.
__Authentication is done by GitLab user token & GitLab url__
## Projects
### List Authorized Projects
Lists all projects that the authenticated user has access to.
```
GET /projects
```
Returns:
```json
[
{
"id" : 271,
"name" : "gitlabhq",
"timeout" : 1800,
"token" : "iPWx6WM4lhHNedGfBpPJNP",
"default_ref" : "master",
"gitlab_url" : "http://demo.gitlabhq.com/gitlab/gitlab-shell",
"always_build" : false,
"polling_interval" : null,
"public" : false,
"ssh_url_to_repo" : "git@demo.gitlab.com:gitlab/gitlab-shell.git",
"gitlab_id" : 3
},
{
"id" : 272,
"name" : "gitlab-ci",
"timeout" : 1800,
"token" : "iPWx6WM4lhHNedGfBpPJNP",
"default_ref" : "master",
"gitlab_url" : "http://demo.gitlabhq.com/gitlab/gitlab-shell",
"always_build" : false,
"polling_interval" : null,
"public" : false,
"ssh_url_to_repo" : "git@demo.gitlab.com:gitlab/gitlab-shell.git",
"gitlab_id" : 4
}
]
```
### List Owned Projects
Lists all projects that the authenticated user owns.
```
GET /projects/owned
```
Returns:
```json
[
{
"id" : 272,
"name" : "gitlab-ci",
"timeout" : 1800,
"token" : "iPWx6WM4lhHNedGfBpPJNP",
"default_ref" : "master",
"gitlab_url" : "http://demo.gitlabhq.com/gitlab/gitlab-shell",
"always_build" : false,
"polling_interval" : null,
"public" : false,
"ssh_url_to_repo" : "git@demo.gitlab.com:gitlab/gitlab-shell.git",
"gitlab_id" : 4
}
]
```
### Single Project
Returns information about a single project for which the user is
authorized.
GET /projects/:id
Parameters:
* `id` (required) - The ID of the Gitlab CI project
### Create Project
Creates a Gitlab CI project using Gitlab project details.
POST /projects
Parameters:
* `name` (required) - The name of the project
* `gitlab_id` (required) - The ID of the project on the Gitlab instance
* `gitlab_url` (required) - The web url of the project on the Gitlab instance
* `ssh_url_to_repo` (required) - The gitlab SSH url to the repo
* `default_ref` (optional) - The branch to run on (default to `master`)
### Update Project
Updates a Gitlab CI project using Gitlab project details that the
authenticated user has access to.
PUT /projects/:id
Parameters:
* `name` - The name of the project
* `gitlab_id` - The ID of the project on the Gitlab instance
* `gitlab_url` - The web url of the project on the Gitlab instance
* `ssh_url_to_repo` - The gitlab SSH url to the repo
* `default_ref` - The branch to run on (default to `master`)
### Remove Project
Removes a Gitlab CI project that the authenticated user has access to.
DELETE /projects/:id
Parameters:
* `id` (required) - The ID of the Gitlab CI project
### Link Project to Runner
Links a runner to a project so that it can make builds (only via
authorized user).
POST /projects/:id/runners/:runner_id
Parameters:
* `id` (required) - The ID of the Gitlab CI project
* `runner_id` (required) - The ID of the Gitlab CI runner
### Remove Project from Runner
Removes a runner from a project so that it can not make builds (only
via authorized user).
DELETE /projects/:id/runners/:runner_id
Parameters:
* `id` (required) - The ID of the Gitlab CI project
* `runner_id` (required) - The ID of the Gitlab CI runner
### List All Jobs for a Project
List the jobs associated to a Gitlab CI Project (only via
authorized user).
GET /projects/:id/jobs
Parameters:
* `id` (required) - The ID of the Gitlab CI project
### Add a parallel Job to a Project
Adds a Job to a Gitlab CI Project (only via
authorized user).
POST /projects/:id/jobs
Parameters:
* `id` (required) - The ID of the Gitlab CI project
* `name` (required) - The name of the Job to add
* `commands` (required) - The script commands of the job
* `active` (optional) - The command is active of not
* `build_branches` (optional) - Trigger commit builds
* `build_tags` (optional) - Trigger tag builds
* `tags` (optional) - The tags associated with this job
### Add a deploy Job to a Project
Adds a deploy Job to a Gitlab CI Project (only via
authorized user).
POST /projects/:id/deploy_jobs
Parameters:
* `id` (required) - The ID of the Gitlab CI project
* `name` (required) - The name of the Job to add
* `commands` (required) - The script commands of the job
* `active` (optional) - The command is active of not
* `refs` (optional) - The list of refs
* `tags` (optional) - The tags associated with this job
### Remove a Job from a Project
Removes a Job from a Gitlab CI Project (only
via authorized user).
DELETE /projects/:id/jobs/:job_id
Parameters:
* `id` (required) - The ID of the Gitlab CI project
* `job_id` (required) - The ID of the Job
|
