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

72 73
## Road to GraphQL

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
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.
2. Callers of the API can request only what they need.
3. It is versioned by default.

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.
89

90 91 92
## Compatibility Guidelines

The HTTP API is versioned using a single number, the current one being 4. This
93
number symbolises the same as the major version number as described by
94 95
[SemVer](https://semver.org/). This mean that backward incompatible changes
will require this version number to change. However, the minor version is
96
not explicit. This allows for a stable API endpoint, but also means new
97 98 99 100
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
101 102 103 104
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
105 106
between v3 and v4; please read the [v3 to v4 documentation](v3_to_v4.md)

107
### Current status
108

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

112 113 114
## Basic usage

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

Douwe Maan's avatar
Douwe Maan committed
118
Example of a valid API request using cURL:
119 120

```shell
Douwe Maan's avatar
Douwe Maan committed
121
curl "https://gitlab.example.com/api/v4/projects"
122 123 124 125 126
```

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

127
## Authentication
128

Douwe Maan's avatar
Douwe Maan committed
129 130
Most API requests require authentication, or will only return public data when
authentication is not provided. For
131 132
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).
133

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

136 137
1. [OAuth2 tokens](#oauth2-tokens)
1. [Personal access tokens](#personal-access-tokens)
Douwe Maan's avatar
Douwe Maan committed
138 139 140 141 142
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:
1. [Impersonation tokens](#impersonation-tokens)
2. [Sudo](#sudo)
143

144 145
If authentication information is invalid or omitted, an error message will be
returned with status code `401`:
146 147 148 149 150 151 152

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

Douwe Maan's avatar
Douwe Maan committed
153
### OAuth2 tokens
154

Douwe Maan's avatar
Douwe Maan committed
155 156
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.
157

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

Douwe Maan's avatar
Douwe Maan committed
160 161 162
```shell
curl https://gitlab.example.com/api/v4/projects?access_token=OAUTH-TOKEN
```
163

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

166
```shell
167
curl --header "Authorization: Bearer OAUTH-TOKEN" https://gitlab.example.com/api/v4/projects
168 169
```

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

Douwe Maan's avatar
Douwe Maan committed
172
### Personal access tokens
173

Douwe Maan's avatar
Douwe Maan committed
174 175
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.
176

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

Douwe Maan's avatar
Douwe Maan committed
179 180 181 182 183
```shell
curl https://gitlab.example.com/api/v4/projects?private_token=9koXpg98eAheJpvBs5tK
```

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

Douwe Maan's avatar
Douwe Maan committed
185 186 187
```shell
curl --header "Private-Token: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects
```
188

Douwe Maan's avatar
Douwe Maan committed
189 190 191 192 193 194 195
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.
196

Douwe Maan's avatar
Douwe Maan committed
197 198 199
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.
200

201
### Impersonation tokens
202

203
> [Introduced][ce-9099] in GitLab 9.0. Needs admin permissions.
204

205
Impersonation tokens are a type of [personal access token][pat]
Douwe Maan's avatar
Douwe Maan committed
206 207
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.
208

Douwe Maan's avatar
Douwe Maan committed
209 210 211
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.
212

213
For more information, refer to the
214
[users API](users.md#retrieve-user-impersonation-tokens) docs.
215

Douwe Maan's avatar
Douwe Maan committed
216 217
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.
218

219
### Sudo
220

221
> Needs admin permissions.
222

223
All API requests support performing an API call as if you were another user,
Douwe Maan's avatar
Douwe Maan committed
224 225 226
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
227
the user you want to perform the operation as. If passed as a header, the
Douwe Maan's avatar
Douwe Maan committed
228
header name must be `Sudo`.
229

Douwe Maan's avatar
Douwe Maan committed
230
If a non administrative access token is provided, an error message will
231
be returned with status code `403`:
232 233 234

```json
{
235
  "message": "403 Forbidden - Must be admin to use sudo"
236 237 238
}
```

Douwe Maan's avatar
Douwe Maan committed
239 240 241 242 243 244 245 246 247 248 249
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"
}
```

250
If the sudo user ID or username cannot be found, an error message will be
251
returned with status code `404`:
252 253 254

```json
{
Douwe Maan's avatar
Douwe Maan committed
255
  "message": "404 User with ID or username '123' Not Found"
256 257 258
}
```

259 260 261 262
---

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

264
```
265
GET /projects?private_token=9koXpg98eAheJpvBs5tK&sudo=username
266
```
267

268
```shell
Douwe Maan's avatar
Douwe Maan committed
269
curl --header "Private-Token: 9koXpg98eAheJpvBs5tK" --header "Sudo: username" "https://gitlab.example.com/api/v4/projects"
270 271
```

272 273
Example of a valid API call and a request using cURL with sudo request,
providing an ID:
274

275
```
276
GET /projects?private_token=9koXpg98eAheJpvBs5tK&sudo=23
277
```
278

279
```shell
Douwe Maan's avatar
Douwe Maan committed
280
curl --header "Private-Token: 9koXpg98eAheJpvBs5tK" --header "Sudo: 23" "https://gitlab.example.com/api/v4/projects"
281
```
282

283 284 285 286 287 288 289 290 291 292 293 294
## 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. |
295
| `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
296
| `DELETE` | Returns `204 No Content` if the resource was deleted successfully. |
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311

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
312
| `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. |
313 314
| `422 Unprocessable` | The entity could not be processed. |
| `500 Server Error` | While handling the request something went wrong server-side. |
315

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
316
## Pagination
Nihad Abbasov's avatar
Nihad Abbasov committed
317

318 319
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
320

321 322
| Parameter | Description |
| --------- | ----------- |
323 324
| `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
325

326 327 328
In the example below, we list 50 [namespaces](namespaces.md) per page.

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

332
### Pagination Link header
333

334
[Link headers](http://www.w3.org/wiki/LinkHeader) are sent back with each
335 336
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.
337

338 339 340 341 342
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
343
curl --head --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/8/issues/8/notes?per_page=3&page=2
344 345
```

346 347 348 349 350 351 352 353
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
354
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"
355 356 357 358 359 360 361 362 363 364
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
365 366 367 368
```

### Other pagination headers

369 370 371 372 373 374 375 376 377 378
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 |
379

380 381
## Namespaced path encoding

382
If using namespaced API calls, make sure that the `NAMESPACE/PROJECT_NAME` is
383 384
URL-encoded.

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

```
388 389 390
GET /api/v4/projects/diaspora%2Fdiaspora
```

391
## Branches and tags name encoding
392 393 394 395 396 397 398 399

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
400 401
```

402 403
## Encoding API parameters of `array` and `hash` types

404
We can call the API with `array` and `hash` types parameters as shown below:
405 406 407 408 409

### `array`

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

410
```bash
411 412 413 414 415 416 417 418 419 420
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`:

421
```bash
422 423 424 425 426 427 428 429 430
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
```

431 432 433 434 435 436 437 438 439 440 441 442 443 444
### 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"
```

445
## `id` vs `iid`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
446

447 448 449 450
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`.
451

452 453
| Parameter | Description |
| --------- | ----------- |
454 455
| `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's avatar
Dmitriy Zaporozhets committed
456

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

459
```
460
GET /projects/42/issues/:id
461
```
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
462

463 464
On the other hand, if you want to create a link to a web page you should use
the `iid`:
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
465

466
```
467
GET /projects/42/issues/:iid
468
```
469 470 471

## Data validation and error reporting

472
When working with the API you may encounter validation errors, in which case
473 474
the API will answer with an HTTP `400` status.

475 476
Such errors appear in two cases:

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

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

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

491 492
When a validation error occurs, error messages will be different. They will
hold all details of validation errors:
493

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

506 507
This makes error messages more machine-readable. The format can be described as
follows:
508

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

528
## Unknown route
529

530
When you try to access an API URL that does not exist you will receive 404 Not Found.
531 532

```
533
HTTP/1.1 404 Not Found
534 535
Content-Type: application/json
{
536
    "error": "404 Not Found"
537 538 539
}
```

540 541 542
## 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
543
a [W3 recommendation](http://www.w3.org/Addressing/URL/4_URI_Recommentations.html) that
544 545 546 547 548 549 550 551 552 553 554 555 556
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
```

557 558 559
## Clients

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

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