README.md 19.5 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 7
The main GitLab API is a [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) API. Therefore, documentation in this section assumes knowledge of REST concepts.

8
## Resources
9

10 11 12
Documentation for various API resources can be found separately in the
following locations:

13
- [Award Emoji](award_emoji.md)
14
- [Branches](branches.md)
15
- [Broadcast Messages](broadcast_messages.md)
Shinya Maeda's avatar
Shinya Maeda committed
16 17
- [Project-level Variables](project_level_variables.md)
- [Group-level Variables](group_level_variables.md)
18
- [Code Snippets](snippets.md)
19
- [Commits](commits.md)
20
- [Custom Attributes](custom_attributes.md)
21
- [Deployments](deployments.md)
22
- [Deploy Keys](deploy_keys.md)
23
- [Dockerfile templates](templates/dockerfiles.md)
24
- [Environments](environments.md)
Mark Fletcher's avatar
Mark Fletcher committed
25
- [Events](events.md)
26
- [Feature flags](features.md)
27
- [Gitignore templates](templates/gitignores.md)
28
- [GitLab CI Config templates](templates/gitlab_ci_ymls.md)
29
- [Groups](groups.md)
30
- [Group Access Requests](access_requests.md)
31
- [Group Badges](group_badges.md)
32
- [Group Members](members.md)
33
- [Issues](issues.md)
34
- [Issue Boards](boards.md)
Felipe's avatar
Felipe committed
35
- [Group Issue Boards](group_boards.md)
36
- [Jobs](jobs.md)
37
- [Keys](keys.md)
38
- [Labels](labels.md)
39
- [Markdown](markdown.md)
40
- [Merge Requests](merge_requests.md)
41 42
- [Project milestones](milestones.md)
- [Group milestones](group_milestones.md)
43
- [Namespaces](namespaces.md)
44
- [Notes](notes.md) (comments)
Jan Provaznik's avatar
Jan Provaznik committed
45
- [Discussions](discussions.md) (threaded comments)
46
- [Resource Label Events](resource_label_events.md)
47
- [Notification settings](notification_settings.md)
48
- [Open source license templates](templates/licenses.md)
49
- [Pages Domains](pages_domains.md)
50
- [Pipelines](pipelines.md)
51
- [Pipeline Triggers](pipeline_triggers.md)
shinya maeda's avatar
shinya maeda committed
52
- [Pipeline Schedules](pipeline_schedules.md)
53
- [Projects](projects.md) including setting Webhooks
54
- [Project Access Requests](access_requests.md)
55
- [Project Badges](project_badges.md)
James Lopez's avatar
James Lopez committed
56
- [Project import/export](project_import_export.md)
57
- [Project Members](members.md)
58
- [Project Snippets](project_snippets.md)
59
- [Project Templates](project_templates.md)
60
- [Protected Branches](protected_branches.md)
Robert Schilling's avatar
Robert Schilling committed
61
- [Protected Tags](protected_tags.md)
62 63
- [Repositories](repositories.md)
- [Repository Files](repository_files.md)
64
- [Runners](runners.md)
65
- [Search](search.md)
66 67
- [Services](services.md)
- [Settings](settings.md)
68
- [Sidekiq metrics](sidekiq_metrics.md)
69 70
- [System Hooks](system_hooks.md)
- [Tags](tags.md)
71
- [Todos](todos.md)
72
- [Users](users.md)
73
- [Validate CI configuration](lint.md)
Oswaldo Ferreira's avatar
Oswaldo Ferreira committed
74
- [V3 to V4](v3_to_v4.md)
75
- [Version](version.md)
76
- [Wikis](wikis.md)
77

78 79
## Road to GraphQL

80 81 82 83 84
Going forward, we will start on moving to
[GraphQL](http://graphql.org/learn/best-practices/) and deprecate the use of
controller-specific endpoints. GraphQL has a number of benefits:

1. We avoid having to maintain two different APIs.
85 86
1. Callers of the API can request only what they need.
1. It is versioned by default.
87 88 89 90 91 92 93 94

It will co-exist with the current v4 REST API. If we have a v5 API, this should
be a compatibility layer on top of GraphQL.

Although there were some patenting and licensing concerns with GraphQL, these
have been resolved to our satisfaction by the relicensing of the reference
implementations under MIT, and the use of the OWF license for the GraphQL
specification.
95

96 97 98
## Compatibility Guidelines

The HTTP API is versioned using a single number, the current one being 4. This
99
number symbolises the same as the major version number as described by
100 101
[SemVer](https://semver.org/). This mean that backward incompatible changes
will require this version number to change. However, the minor version is
102
not explicit. This allows for a stable API endpoint, but also means new
103 104 105 106
features can be added to the API in the same version number.

New features and bug fixes are released in tandem with a new GitLab, and apart
from incidental patch and security releases, are released on the 22nd each
107 108 109 110
month. Backward incompatible changes (e.g. endpoints removal, parameters
removal etc.), as well as removal of entire API versions are done in tandem
with a major point release of GitLab itself. All deprecations and changes
between two versions should be listed in the documentation. For the changes
111 112
between v3 and v4; please read the [v3 to v4 documentation](v3_to_v4.md)

113
### Current status
114

115
Currently only API version v4 is available. Version v3 was removed in
116 117
[GitLab 11.0](https://gitlab.com/gitlab-org/gitlab-ce/issues/36819).

118 119 120
## Basic usage

API requests should be prefixed with `api` and the API version. The API version
121 122
is defined in [`lib/api.rb`][lib-api-url]. For example, the root of the v4 API
is at `/api/v4`.
123

Douwe Maan's avatar
Douwe Maan committed
124
Example of a valid API request using cURL:
125 126

```shell
Douwe Maan's avatar
Douwe Maan committed
127
curl "https://gitlab.example.com/api/v4/projects"
128 129 130 131 132
```

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

133
## Authentication
134

Douwe Maan's avatar
Douwe Maan committed
135 136
Most API requests require authentication, or will only return public data when
authentication is not provided. For
137 138
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).
139

Douwe Maan's avatar
Douwe Maan committed
140
There are three ways to authenticate with the GitLab API:
141

142 143
1. [OAuth2 tokens](#oauth2-tokens)
1. [Personal access tokens](#personal-access-tokens)
Douwe Maan's avatar
Douwe Maan committed
144 145 146
1. [Session cookie](#session-cookie)

For admins who want to authenticate with the API as a specific user, or who want to build applications or scripts that do so, two options are available:
147

Douwe Maan's avatar
Douwe Maan committed
148
1. [Impersonation tokens](#impersonation-tokens)
149
1. [Sudo](#sudo)
150

151 152
If authentication information is invalid or omitted, an error message will be
returned with status code `401`:
153 154 155 156 157 158 159

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

Douwe Maan's avatar
Douwe Maan committed
160
### OAuth2 tokens
161

Douwe Maan's avatar
Douwe Maan committed
162 163
You can use an [OAuth2 token](oauth2.md) to authenticate with the API by passing it in either the
`access_token` parameter or the `Authorization` header.
164

Douwe Maan's avatar
Douwe Maan committed
165
Example of using the OAuth2 token in a parameter:
166

Douwe Maan's avatar
Douwe Maan committed
167 168 169
```shell
curl https://gitlab.example.com/api/v4/projects?access_token=OAUTH-TOKEN
```
170

Douwe Maan's avatar
Douwe Maan committed
171
Example of using the OAuth2 token in a header:
172

173
```shell
174
curl --header "Authorization: Bearer OAUTH-TOKEN" https://gitlab.example.com/api/v4/projects
175 176
```

Douwe Maan's avatar
Douwe Maan committed
177
Read more about [GitLab as an OAuth2 provider](oauth2.md).
178

Douwe Maan's avatar
Douwe Maan committed
179
### Personal access tokens
180

Douwe Maan's avatar
Douwe Maan committed
181 182
You can use a [personal access token][pat] to authenticate with the API by passing it in either the
`private_token` parameter or the `Private-Token` header.
183

Douwe Maan's avatar
Douwe Maan committed
184
Example of using the personal access token in a parameter:
185

Douwe Maan's avatar
Douwe Maan committed
186 187 188 189 190
```shell
curl https://gitlab.example.com/api/v4/projects?private_token=9koXpg98eAheJpvBs5tK
```

Example of using the personal access token in a header:
191

Douwe Maan's avatar
Douwe Maan committed
192 193 194
```shell
curl --header "Private-Token: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects
```
195

Douwe Maan's avatar
Douwe Maan committed
196 197 198 199 200 201 202
Read more about [personal access tokens][pat].

### Session cookie

When signing in to the main GitLab application, 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.
203

Douwe Maan's avatar
Douwe Maan committed
204 205 206
The primary user of this authentication method is the web frontend of GitLab itself,
which can use the API as the authenticated user to get a list of their projects,
for example, without needing to explicitly pass an access token.
207

208
### Impersonation tokens
209

210
> [Introduced][ce-9099] in GitLab 9.0. Needs admin permissions.
211

212
Impersonation tokens are a type of [personal access token][pat]
Douwe Maan's avatar
Douwe Maan committed
213 214
that can only be created by an admin for a specific user. They are a great fit
if you want to build applications or scripts that authenticate with the API as a specific user.
215

Douwe Maan's avatar
Douwe Maan committed
216 217 218
They are an alternative to directly using the user's password or one of their
personal access tokens, and to using the [Sudo](#sudo) feature, since the user's (or admin's, in the case of Sudo)
password/token may not be known or may change over time.
219

220
For more information, refer to the
221
[users API](users.md#retrieve-user-impersonation-tokens) docs.
222

Douwe Maan's avatar
Douwe Maan committed
223 224
Impersonation tokens are used exactly like regular personal access tokens, and can be passed in either the
`private_token` parameter or the `Private-Token` header.
225

226
### Sudo
227

228
NOTE: **Note:**
229
Only available to [administrators](../user/permissions.md).
230

231
All API requests support performing an API call as if you were another user,
Douwe Maan's avatar
Douwe Maan committed
232 233 234
provided you are authenticated as an administrator with an OAuth or Personal Access Token that has the `sudo` scope.

You need to pass the `sudo` parameter either via query string or a header with an ID/username of
235
the user you want to perform the operation as. If passed as a header, the
Douwe Maan's avatar
Douwe Maan committed
236
header name must be `Sudo`.
237

Douwe Maan's avatar
Douwe Maan committed
238
If a non administrative access token is provided, an error message will
239
be returned with status code `403`:
240 241 242

```json
{
243
  "message": "403 Forbidden - Must be admin to use sudo"
244 245 246
}
```

Douwe Maan's avatar
Douwe Maan committed
247 248 249 250 251 252 253 254 255 256 257
If an access token without the `sudo` scope is provided, an error message will
be returned with status code `403`:

```json
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token.",
  "scope": "sudo"
}
```

258
If the sudo user ID or username cannot be found, an error message will be
259
returned with status code `404`:
260 261 262

```json
{
Douwe Maan's avatar
Douwe Maan committed
263
  "message": "404 User with ID or username '123' Not Found"
264 265 266
}
```

267 268 269 270
---

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

272
```
273
GET /projects?private_token=9koXpg98eAheJpvBs5tK&sudo=username
274
```
275

276
```shell
Douwe Maan's avatar
Douwe Maan committed
277
curl --header "Private-Token: 9koXpg98eAheJpvBs5tK" --header "Sudo: username" "https://gitlab.example.com/api/v4/projects"
278 279
```

280 281
Example of a valid API call and a request using cURL with sudo request,
providing an ID:
282

283
```
284
GET /projects?private_token=9koXpg98eAheJpvBs5tK&sudo=23
285
```
286

287
```shell
Douwe Maan's avatar
Douwe Maan committed
288
curl --header "Private-Token: 9koXpg98eAheJpvBs5tK" --header "Sudo: 23" "https://gitlab.example.com/api/v4/projects"
289
```
290

291 292 293 294 295 296 297 298 299 300 301 302
## 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. |
303
| `GET` / `PUT` | Return `200 OK` if the resource is accessed or modified successfully. The (modified) result is returned as JSON. |
Pascal Borreli's avatar
Pascal Borreli committed
304
| `DELETE` | Returns `204 No Content` if the resource was deleted successfully. |
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319

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. |
Robert Schilling's avatar
Robert Schilling committed
320
| `412` | Indicates the request was denied. May happen if the `If-Unmodified-Since` header is provided when trying to delete a resource, which was modified in between. |
321 322
| `422 Unprocessable` | The entity could not be processed. |
| `500 Server Error` | While handling the request something went wrong server-side. |
323

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
324
## Pagination
Nihad Abbasov's avatar
Nihad Abbasov committed
325

326 327
Sometimes the returned result will span across many pages. When listing
resources you can pass the following parameters:
Nihad Abbasov's avatar
Nihad Abbasov committed
328

329 330
| Parameter | Description |
| --------- | ----------- |
331 332
| `page`    | Page number (default: `1`) |
| `per_page`| Number of items to list per page (default: `20`, max: `100`) |
Nihad Abbasov's avatar
Nihad Abbasov committed
333

334 335 336
In the example below, we list 50 [namespaces](namespaces.md) per page.

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

340
### Pagination Link header
341

342
[Link headers](http://www.w3.org/wiki/LinkHeader) are sent back with each
343 344
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.
345

346 347 348 349 350
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
351
curl --head --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/8/issues/8/notes?per_page=3&page=2
352 353
```

354 355 356 357 358 359 360 361
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
362
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"
363 364 365 366 367 368 369 370 371 372
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
373 374 375 376
```

### Other pagination headers

377 378 379 380 381 382 383 384 385 386
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 |
387

388 389
## Namespaced path encoding

390
If using namespaced API calls, make sure that the `NAMESPACE/PROJECT_NAME` is
391 392
URL-encoded.

393
For example, `/` is represented by `%2F`:
394 395

```
396 397 398
GET /api/v4/projects/diaspora%2Fdiaspora
```

399
## Branches and tags name encoding
400 401 402 403 404 405 406 407

If your branch or tag contains a `/`, make sure the branch/tag name is
URL-encoded.

For example, `/` is represented by `%2F`:

```
GET /api/v4/projects/1/branches/my%2Fbranch/commits
408 409
```

410 411
## Encoding API parameters of `array` and `hash` types

412
We can call the API with `array` and `hash` types parameters as shown below:
413 414 415 416 417

### `array`

`import_sources` is a parameter of type `array`:

418
```bash
419 420 421 422 423 424 425 426 427 428
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" \
-d "import_sources[]=github" \
-d "import_sources[]=bitbucket" \
"https://gitlab.example.com/api/v4/some_endpoint
```

### `hash`

`override_params` is a parameter of type `hash`:

429
```bash
430 431 432 433 434 435 436 437 438
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" \
--form "namespace=email" \
--form "path=impapi" \
--form "file=@/path/to/somefile.txt"
--form "override_params[visibility]=private" \
--form "override_params[some_other_param]=some_value" \
https://gitlab.example.com/api/v4/projects/import
```

439 440 441 442 443 444 445 446 447 448 449 450 451 452
### Array of hashes

`variables` is a parameter of type `array` containing hash key/value pairs `[{ 'key' => 'UPLOAD_TO_S3', 'value' => 'true' }]`:

```bash
curl --globoff --request POST --header "PRIVATE-TOKEN: ********************" \
"https://gitlab.example.com/api/v4/projects/169/pipeline?ref=master&variables[][key]=VAR1&variables[][value]=hello&variables[][key]=VAR2&variables[][value]=world"

curl --request POST --header "PRIVATE-TOKEN: ********************" \
--header "Content-Type: application/json" \
--data '{ "ref": "master", "variables": [ {"key": "VAR1", "value": "hello"}, {"key": "VAR2", "value": "world"} ] }' \
"https://gitlab.example.com/api/v4/projects/169/pipeline"
```

453
## `id` vs `iid`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
454

455
 Some resources have two similarly-named fields. For example, [issues](issues.md), [merge requests](merge_requests.md), and [project milestones](merge_requests.md). The fields are:
456

457 458
- `id`: ID that is unique across all projects.
- `iid`: additional, internal ID that is unique in the scope of a single project.
459

460 461
NOTE: **Note:**
The `iid` is displayed in the web UI.
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
462

463
If a resource has the `iid` field and the `id` field, the `iid` field is usually used instead of `id` to fetch the resource.
464

465
For example, suppose a project with `id: 42` has an issue with `id: 46` and `iid: 5`. In this case:
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
466

467 468
- A valid API call to retrieve the issue is  `GET /projects/42/issues/5`
- An invalid API call to retrieve the issue is `GET /projects/42/issues/46`.
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
469

470
NOTE: **Note:**
471
Not all resources with the `iid` field are fetched by `iid`. For guidance on which field to use, see the documentation for the specific resource.
472 473 474

## Data validation and error reporting

475
When working with the API you may encounter validation errors, in which case
476 477
the API will answer with an HTTP `400` status.

478 479
Such errors appear in two cases:

480
- A required attribute of the API request is missing, e.g., the title of an
481
  issue is not given
482
- An attribute did not pass the validation, e.g., user bio is too long
483 484 485

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

486
```
487 488 489 490 491 492
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
    "message":"400 (Bad request) \"title\" not given"
}
```
493

494 495
When a validation error occurs, error messages will be different. They will
hold all details of validation errors:
496

497
```
498 499 500 501 502 503 504
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
    "message": {
        "bio": [
            "is too long (maximum is 255 characters)"
        ]
505
    }
506 507
}
```
508

509 510
This makes error messages more machine-readable. The format can be described as
follows:
511

512 513 514 515 516 517 518 519 520
```json
{
    "message": {
        "<property-name>": [
            "<error-message>",
            "<error-message>",
            ...
        ],
        "<embed-entity>": {
521 522 523 524 525 526 527
            "<property-name>": [
                "<error-message>",
                "<error-message>",
                ...
            ],
        }
    }
528 529 530
}
```

531
## Unknown route
532

533
When you try to access an API URL that does not exist you will receive 404 Not Found.
534 535

```
536
HTTP/1.1 404 Not Found
537 538
Content-Type: application/json
{
539
    "error": "404 Not Found"
540 541 542
}
```

543 544 545
## Encoding `+` in ISO 8601 dates

If you need to include a `+` in a query parameter, you may need to use `%2B` instead due
Connor Shea's avatar
Connor Shea committed
546
a [W3 recommendation](http://www.w3.org/Addressing/URL/4_URI_Recommentations.html) that
547 548 549 550 551 552 553 554 555 556 557 558 559
causes a `+` to be interpreted as a space. For example, in an ISO 8601 date, you may want to pass
a time in Mountain Standard Time, such as:

```
2017-10-17T23:11:13.000+05:30
```

The correct encoding for the query parameter would be:

```
2017-10-17T23:11:13.000%2B05:30
```

560 561 562
## Clients

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

565 566
[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
567
[ce-3749]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3749
568
[ce-5951]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5951
569
[ce-9099]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9099
570
[pat]: ../user/profile/personal_access_tokens.md