BigW Consortium Gitlab

README.md 13.9 KB
Newer Older
1
# GitLab API
2

3
Automate GitLab via a simple and powerful API. All definitions can be found
4
under [`/lib/api`](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/lib/api).
5

6
## Resources
7

8 9 10
Documentation for various API resources can be found separately in the
following locations:

11
- [Award Emoji](award_emoji.md)
12
- [Branches](branches.md)
13
- [Broadcast Messages](broadcast_messages.md)
14 15
- [Build Variables](build_variables.md)
- [Commits](commits.md)
16
- [Deployments](deployments.md)
17
- [Deploy Keys](deploy_keys.md)
18 19
- [Gitignores templates](templates/gitignores.md)
- [GitLab CI Config templates](templates/gitlab_ci_ymls.md)
20
- [Groups](groups.md)
21 22
- [Group Access Requests](access_requests.md)
- [Group Members](members.md)
23
- [Issues](issues.md)
24
- [Issue Boards](boards.md)
25
- [Jobs](jobs.md)
26
- [Keys](keys.md)
27
- [Labels](labels.md)
28
- [Merge Requests](merge_requests.md)
29
- [Milestones](milestones.md)
30
- [Open source license templates](templates/licenses.md)
31
- [Namespaces](namespaces.md)
32
- [Notes](notes.md) (comments)
33
- [Notification settings](notification_settings.md)
34
- [Pipelines](pipelines.md)
35
- [Pipeline Triggers](pipeline_triggers.md)
36
- [Projects](projects.md) including setting Webhooks
37 38
- [Project Access Requests](access_requests.md)
- [Project Members](members.md)
39 40 41
- [Project Snippets](project_snippets.md)
- [Repositories](repositories.md)
- [Repository Files](repository_files.md)
42
- [Runners](runners.md)
43 44 45
- [Services](services.md)
- [Session](session.md)
- [Settings](settings.md)
46
- [Sidekiq metrics](sidekiq_metrics.md)
47 48
- [System Hooks](system_hooks.md)
- [Tags](tags.md)
49
- [Todos](todos.md)
50
- [Users](users.md)
51
- [Validate CI configuration](ci/lint.md)
52
- [V3 to V4](v3_to_v4.md)
53
- [Version](version.md)
54 55 56 57 58 59 60

### Internal CI API

The following documentation is for the [internal CI API](ci/README.md):

- [Builds](ci/builds.md)
- [Runners](ci/runners.md)
61

62
## Authentication
63

64 65 66
Most API requests require authentication via a session cookie or token. For those cases where it is not required, this will be mentioned in the documentation 
for each individual endpoint. For example, the [`/projects/:id` endpoint](projects.md). 
There are three types of tokens available: private tokens, OAuth 2 tokens, and personal
67
access tokens.
68

69 70
If authentication information is invalid or omitted, an error message will be
returned with status code `401`:
71 72 73 74 75 76 77

```json
{
  "message": "401 Unauthorized"
}
```

78 79 80 81 82 83
### Session Cookie

When signing in to GitLab as an ordinary user, a `_gitlab_session` cookie is
set. The API will use this cookie for authentication if it is present, but using
the API to generate a new session cookie is currently not supported.

84
### Private Tokens
85

86 87
You need to pass a `private_token` parameter via query string or header. If passed as a
header, the header name must be `PRIVATE-TOKEN` (uppercase and with a dash instead of
88 89
an underscore). You can find or reset your private token in your account page
(`/profile/account`).
90

91
### OAuth 2 Tokens
92

93 94 95 96
You can use an OAuth 2 token to authenticate with the API by passing it either in the
`access_token` parameter or in the `Authorization` header.

Example of using the OAuth2 token in the header:
97

98
```shell
99
curl --header "Authorization: Bearer OAUTH-TOKEN" https://gitlab.example.com/api/v4/projects
100 101
```

102 103 104
Read more about [GitLab as an OAuth2 client](oauth2.md).

### Personal Access Tokens
105

106
> [Introduced][ce-3749] in GitLab 8.8.
107

108
You can create as many personal access tokens as you like from your GitLab
109 110
profile (`/profile/personal_access_tokens`); perhaps one for each application
that needs access to the GitLab API.
111

112 113
Once you have your token, pass it to the API using either the `private_token`
parameter or the `PRIVATE-TOKEN` header.
114

115 116 117 118 119 120 121
> [Introduced][ce-5951] in GitLab 8.15.

Personal Access Tokens can be created with one or more scopes that allow various actions
that a given token can perform. Although there are only two scopes available at the
moment – `read_user` and `api` – the groundwork has been laid to add more scopes easily.

At any time you can revoke any personal access token by just clicking **Revoke**.
122

123
### Impersonation tokens
124

125
> [Introduced][ce-9099] in GitLab 9.0. Needs admin permissions.
126

127 128
Impersonation tokens are a type of [Personal Access Token](#personal-access-tokens)
that can only be created by an admin for a specific user.
129

130 131 132 133 134
They are a better alternative to using the user's password/private token
or using the [Sudo](#sudo) feature which also requires the admin's password
or private token, since the password/token can change over time. Impersonation
tokens are a great fit if you want to build applications or tools which
authenticate with the API as a specific user.
135

136 137
For more information about the usage please refer to the
[users API](users.md#retrieve-user-impersonation-tokens) docs.
138

139
### Sudo
140

141
> Needs admin permissions.
142

143
All API requests support performing an API call as if you were another user,
144
provided your private token is from an administrator account. You need to pass
145 146 147
the `sudo` parameter either via query string or a header with an ID/username of
the user you want to perform the operation as. If passed as a header, the
header name must be `SUDO` (uppercase).
148

149 150
If a non administrative `private_token` is provided, then an error message will
be returned with status code `403`:
151 152 153

```json
{
154
  "message": "403 Forbidden - Must be admin to use sudo"
155 156 157
}
```

158
If the sudo user ID or username cannot be found, an error message will be
159
returned with status code `404`:
160 161 162 163 164 165 166

```json
{
  "message": "404 Not Found: No user id or username for: <id/username>"
}
```

167 168 169 170
---

Example of a valid API call and a request using cURL with sudo request,
providing a username:
171

172
```
173
GET /projects?private_token=9koXpg98eAheJpvBs5tK&sudo=username
174
```
175

176
```shell
177
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --header "SUDO: username" "https://gitlab.example.com/api/v4/projects"
178 179
```

180 181
Example of a valid API call and a request using cURL with sudo request,
providing an ID:
182

183
```
184
GET /projects?private_token=9koXpg98eAheJpvBs5tK&sudo=23
185
```
186

187
```shell
188
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --header "SUDO: 23" "https://gitlab.example.com/api/v4/projects"
189
```
190

191 192 193 194 195 196
## Basic Usage

API requests should be prefixed with `api` and the API version. The API version
is defined in [`lib/api.rb`][lib-api-url].

Example of a valid API request:
197

198 199
```
GET /projects?private_token=9koXpg98eAheJpvBs5tK
200
```
201

202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
Example of a valid API request using cURL and authentication via header:

```shell
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects"
```

The API uses JSON to serialize data. You don't need to specify `.json` at the
end of an API URL.

## Status codes

The API is designed to return different status codes according to context and
action. This way, if a request results in an error, the caller is able to get
insight into what went wrong.

The following table gives an overview of how the API functions generally behave.

| Request type | Description |
| ------------ | ----------- |
| `GET`   | Access one or more resources and return the result as JSON. |
| `POST`  | Return `201 Created` if the resource is successfully created and return the newly created resource as JSON. |
| `GET` / `PUT` / `DELETE` | Return `200 OK` if the resource is accessed, modified or deleted successfully. The (modified) result is returned as JSON. |
| `DELETE` | Designed to be idempotent, meaning a request to a resource still returns `200 OK` even it was deleted before or is not available. The reasoning behind this, is that the user is not really interested if the resource existed before or not. |

The following table shows the possible return codes for API requests.

| Return values | Description |
| ------------- | ----------- |
| `200 OK` | The `GET`, `PUT` or `DELETE` request was successful, the resource(s) itself is returned as JSON. |
| `204 No Content` | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. |
| `201 Created` | The `POST` request was successful and the resource is returned as JSON. |
| `304 Not Modified` | Indicates that the resource has not been modified since the last request. |
| `400 Bad Request` | A required attribute of the API request is missing, e.g., the title of an issue is not given. |
| `401 Unauthorized` | The user is not authenticated, a valid [user token](#authentication) is necessary. |
| `403 Forbidden` | The request is not allowed, e.g., the user is not allowed to delete a project. |
| `404 Not Found` | A resource could not be accessed, e.g., an ID for a resource could not be found. |
| `405 Method Not Allowed` | The request is not supported. |
| `409 Conflict` | A conflicting resource already exists, e.g., creating a project with a name that already exists. |
| `422 Unprocessable` | The entity could not be processed. |
| `500 Server Error` | While handling the request something went wrong server-side. |
242

Dmitriy Zaporozhets committed
243
## Pagination
Nihad Abbasov committed
244

245 246
Sometimes the returned result will span across many pages. When listing
resources you can pass the following parameters:
Nihad Abbasov committed
247

248 249
| Parameter | Description |
| --------- | ----------- |
250 251
| `page`    | Page number (default: `1`) |
| `per_page`| Number of items to list per page (default: `20`, max: `100`) |
Nihad Abbasov committed
252

253 254 255
In the example below, we list 50 [namespaces](namespaces.md) per page.

```bash
256
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/namespaces?per_page=50
257 258
```

259
### Pagination Link header
260

261
[Link headers](http://www.w3.org/wiki/LinkHeader) are sent back with each
262 263
response. They have `rel` set to prev/next/first/last and contain the relevant
URL. Please use these links instead of generating your own URLs.
264

265 266 267 268 269
In the cURL example below, we limit the output to 3 items per page (`per_page=3`)
and we request the second page (`page=2`) of [comments](notes.md) of the issue
with ID `8` which belongs to the project with ID `8`:

```bash
270
curl --head --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/8/issues/8/notes?per_page=3&page=2
271 272
```

273 274 275 276 277 278 279 280
The response will then be:

```
HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 1103
Content-Type: application/json
Date: Mon, 18 Jan 2016 09:43:18 GMT
281
Link: <https://gitlab.example.com/api/v4/projects/8/issues/8/notes?page=1&per_page=3>; rel="prev", <https://gitlab.example.com/api/v4/projects/8/issues/8/notes?page=3&per_page=3>; rel="next", <https://gitlab.example.com/api/v4/projects/8/issues/8/notes?page=1&per_page=3>; rel="first", <https://gitlab.example.com/api/v4/projects/8/issues/8/notes?page=3&per_page=3>; rel="last"
282 283 284 285 286 287 288 289 290 291
Status: 200 OK
Vary: Origin
X-Next-Page: 3
X-Page: 2
X-Per-Page: 3
X-Prev-Page: 1
X-Request-Id: 732ad4ee-9870-4866-a199-a9db0cde3c86
X-Runtime: 0.108688
X-Total: 8
X-Total-Pages: 3
292 293 294 295
```

### Other pagination headers

296 297 298 299 300 301 302 303 304 305
Additional pagination headers are also sent back.

| Header | Description |
| ------ | ----------- |
| `X-Total`       | The total number of items |
| `X-Total-Pages` | The total number of pages |
| `X-Per-Page`    | The number of items per page |
| `X-Page`        | The index of the current page (starting at 1) |
| `X-Next-Page`   | The index of the next page |
| `X-Prev-Page`   | The index of the previous page |
306

307 308
## Namespaced path encoding

309
If using namespaced API calls, make sure that the `NAMESPACE/PROJECT_NAME` is
310 311
URL-encoded.

312
For example, `/` is represented by `%2F`:
313 314 315 316 317

```
/api/v4/projects/diaspora%2Fdiaspora
```

318
## `id` vs `iid`
Dmitriy Zaporozhets committed
319

320 321 322 323
When you work with the API, you may notice two similar fields in API entities:
`id` and `iid`. The main difference between them is scope.

For example, an issue might have `id: 46` and `iid: 5`.
324

325 326
| Parameter | Description |
| --------- | ----------- |
327 328
| `id`  | Is unique across all issues and is used for any API call |
| `iid` | Is unique only in scope of a single project. When you browse issues or merge requests with the Web UI, you see the `iid` |
Dmitriy Zaporozhets committed
329

330
That means that if you want to get an issue via the API you should use the `id`:
331

332
```
333
GET /projects/42/issues/:id
334
```
Dmitriy Zaporozhets committed
335

336 337
On the other hand, if you want to create a link to a web page you should use
the `iid`:
Dmitriy Zaporozhets committed
338

339
```
340
GET /projects/42/issues/:iid
341
```
342 343 344

## Data validation and error reporting

345
When working with the API you may encounter validation errors, in which case
346 347
the API will answer with an HTTP `400` status.

348 349
Such errors appear in two cases:

350
- A required attribute of the API request is missing, e.g., the title of an
351
  issue is not given
352
- An attribute did not pass the validation, e.g., user bio is too long
353 354 355

When an attribute is missing, you will get something like:

356
```
357 358 359 360 361 362
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
    "message":"400 (Bad request) \"title\" not given"
}
```
363

364 365
When a validation error occurs, error messages will be different. They will
hold all details of validation errors:
366

367
```
368 369 370 371 372 373 374
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
    "message": {
        "bio": [
            "is too long (maximum is 255 characters)"
        ]
375
    }
376 377
}
```
378

379 380
This makes error messages more machine-readable. The format can be described as
follows:
381

382 383 384 385 386 387 388 389 390
```json
{
    "message": {
        "<property-name>": [
            "<error-message>",
            "<error-message>",
            ...
        ],
        "<embed-entity>": {
391 392 393 394 395 396 397
            "<property-name>": [
                "<error-message>",
                "<error-message>",
                ...
            ],
        }
    }
398 399 400
}
```

401
## Unknown route
402

403
When you try to access an API URL that does not exist you will receive 404 Not Found.
404 405

```
406
HTTP/1.1 404 Not Found
407 408
Content-Type: application/json
{
409
    "error": "404 Not Found"
410 411 412
}
```

413 414 415
## Clients

There are many unofficial GitLab API Clients for most of the popular
416
programming languages. Visit the [GitLab website] for a complete list.
417

418 419
[GitLab website]: https://about.gitlab.com/applications/#api-clients "Clients using the GitLab API"
[lib-api-url]: https://gitlab.com/gitlab-org/gitlab-ce/tree/master/lib/api/api.rb
420
[ce-3749]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3749
421
[ce-5951]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5951
422
[ce-9099]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9099