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

75 76
## Road to GraphQL

77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
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.
92

93 94 95
## Basic usage

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

Douwe Maan's avatar
Douwe Maan committed
99
Example of a valid API request using cURL:
100 101

```shell
Douwe Maan's avatar
Douwe Maan committed
102
curl "https://gitlab.example.com/api/v4/projects"
103 104 105 106 107
```

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

108
## Authentication
109

Douwe Maan's avatar
Douwe Maan committed
110 111
Most API requests require authentication, or will only return public data when
authentication is not provided. For
112 113 114
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).

Douwe Maan's avatar
Douwe Maan committed
115
There are three ways to authenticate with the GitLab API:
116 117 118

1. [OAuth2 tokens](#oauth2-tokens)
1. [Personal access tokens](#personal-access-tokens)
Douwe Maan's avatar
Douwe Maan committed
119 120 121 122 123
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)
124

125 126
If authentication information is invalid or omitted, an error message will be
returned with status code `401`:
Nihad Abbasov's avatar
Nihad Abbasov committed
127 128 129 130 131 132 133

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

Douwe Maan's avatar
Douwe Maan committed
134
### OAuth2 tokens
135

Douwe Maan's avatar
Douwe Maan committed
136 137
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.
138

Douwe Maan's avatar
Douwe Maan committed
139
Example of using the OAuth2 token in a parameter:
Nihad Abbasov's avatar
Nihad Abbasov committed
140

Douwe Maan's avatar
Douwe Maan committed
141 142 143
```shell
curl https://gitlab.example.com/api/v4/projects?access_token=OAUTH-TOKEN
```
144

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

147
```shell
148
curl --header "Authorization: Bearer OAUTH-TOKEN" https://gitlab.example.com/api/v4/projects
149 150
```

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

Douwe Maan's avatar
Douwe Maan committed
153
### Personal access tokens
Nihad Abbasov's avatar
Nihad Abbasov committed
154

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

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

Douwe Maan's avatar
Douwe Maan committed
160 161 162 163 164
```shell
curl https://gitlab.example.com/api/v4/projects?private_token=9koXpg98eAheJpvBs5tK
```

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

Douwe Maan's avatar
Douwe Maan committed
166 167 168
```shell
curl --header "Private-Token: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects
```
169

Douwe Maan's avatar
Douwe Maan committed
170 171 172 173 174 175 176
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.
177

Douwe Maan's avatar
Douwe Maan committed
178 179 180
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.
181

182
### Impersonation tokens
183

184
> [Introduced][ce-9099] in GitLab 9.0. Needs admin permissions.
185

186
Impersonation tokens are a type of [personal access token][pat]
Douwe Maan's avatar
Douwe Maan committed
187 188
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.
189

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

194
For more information, refer to the
195
[users API](users.md#retrieve-user-impersonation-tokens) docs.
196

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

200
### Sudo
201

202
> Needs admin permissions.
203

204
All API requests support performing an API call as if you were another user,
Douwe Maan's avatar
Douwe Maan committed
205 206 207
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
208
the user you want to perform the operation as. If passed as a header, the
Douwe Maan's avatar
Douwe Maan committed
209
header name must be `Sudo`.
210

Douwe Maan's avatar
Douwe Maan committed
211
If a non administrative access token is provided, an error message will
212
be returned with status code `403`:
213 214 215

```json
{
216
  "message": "403 Forbidden - Must be admin to use sudo"
217 218 219
}
```

Douwe Maan's avatar
Douwe Maan committed
220 221 222 223 224 225 226 227 228 229 230
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"
}
```

231
If the sudo user ID or username cannot be found, an error message will be
232
returned with status code `404`:
233 234 235

```json
{
Douwe Maan's avatar
Douwe Maan committed
236
  "message": "404 User with ID or username '123' Not Found"
237 238 239
}
```

240
---
241

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

245
```
246
GET /projects?private_token=9koXpg98eAheJpvBs5tK&sudo=username
247
```
248

249
```shell
Douwe Maan's avatar
Douwe Maan committed
250
curl --header "Private-Token: 9koXpg98eAheJpvBs5tK" --header "Sudo: username" "https://gitlab.example.com/api/v4/projects"
251 252
```

253 254
Example of a valid API call and a request using cURL with sudo request,
providing an ID:
255

256
```
257
GET /projects?private_token=9koXpg98eAheJpvBs5tK&sudo=23
258
```
259

260
```shell
Douwe Maan's avatar
Douwe Maan committed
261
curl --header "Private-Token: 9koXpg98eAheJpvBs5tK" --header "Sudo: 23" "https://gitlab.example.com/api/v4/projects"
262
```
263

264 265 266 267 268 269 270 271 272 273 274 275
## 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. |
276 277
| `GET` / `PUT` | Return `200 OK` if the resource is accessed or modified successfully. The (modified) result is returned as JSON. |
| `DELETE` | Returns `204 No Content` if the resuource was deleted successfully. |
278

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

281 282 283 284 285 286 287 288 289 290 291 292
| 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
293
| `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. |
294 295
| `422 Unprocessable` | The entity could not be processed. |
| `500 Server Error` | While handling the request something went wrong server-side. |
296

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
297
## Pagination
Nihad Abbasov's avatar
Nihad Abbasov committed
298

299 300
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
301

302 303
| Parameter | Description |
| --------- | ----------- |
304 305
| `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
306

307 308 309
In the example below, we list 50 [namespaces](namespaces.md) per page.

```bash
310
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/namespaces?per_page=50
311
```
Nihad Abbasov's avatar
Nihad Abbasov committed
312

313
### Pagination Link header
314

315 316 317
[Link headers](http://www.w3.org/wiki/LinkHeader) are sent back with each
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.
318

319 320 321 322 323
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
324
curl --head --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/8/issues/8/notes?per_page=3&page=2
325 326
```

327 328 329 330 331 332 333 334
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
335
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"
336 337 338 339 340 341 342 343 344 345
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
346 347 348 349
```

### Other pagination headers

350 351 352 353 354 355 356 357 358 359
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 |
360

361 362
## Namespaced path encoding

363
If using namespaced API calls, make sure that the `NAMESPACE/PROJECT_NAME` is
364 365
URL-encoded.

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

```
369 370 371 372 373 374 375 376 377 378 379 380
GET /api/v4/projects/diaspora%2Fdiaspora
```

## Branches & tags name encoding

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
381 382
```

383
## `id` vs `iid`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
384

385 386
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.
387

388
For example, an issue might have `id: 46` and `iid: 5`.
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
389

390 391
| Parameter | Description |
| --------- | ----------- |
392 393
| `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
394

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

397
```
398
GET /projects/42/issues/:id
399
```
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
400

401 402
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
403

404
```
405
GET /projects/42/issues/:iid
406
```
407 408 409

## Data validation and error reporting

410
When working with the API you may encounter validation errors, in which case
411 412
the API will answer with an HTTP `400` status.

413 414
Such errors appear in two cases:

415
- A required attribute of the API request is missing, e.g., the title of an
416
  issue is not given
417
- An attribute did not pass the validation, e.g., user bio is too long
418 419 420

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

421
```
422 423 424 425 426 427
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
    "message":"400 (Bad request) \"title\" not given"
}
```
428

429 430
When a validation error occurs, error messages will be different. They will
hold all details of validation errors:
431

432
```
433 434 435 436 437 438 439
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
    "message": {
        "bio": [
            "is too long (maximum is 255 characters)"
        ]
440
    }
441 442
}
```
443

444 445
This makes error messages more machine-readable. The format can be described as
follows:
446

447 448 449 450 451 452 453 454 455
```json
{
    "message": {
        "<property-name>": [
            "<error-message>",
            "<error-message>",
            ...
        ],
        "<embed-entity>": {
456 457 458 459 460 461 462
            "<property-name>": [
                "<error-message>",
                "<error-message>",
                ...
            ],
        }
    }
463 464 465
}
```

466
## Unknown route
467

468
When you try to access an API URL that does not exist you will receive 404 Not Found.
469 470

```
471
HTTP/1.1 404 Not Found
472 473
Content-Type: application/json
{
474
    "error": "404 Not Found"
475 476 477
}
```

478 479 480
## 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
481
a [W3 recommendation](http://www.w3.org/Addressing/URL/4_URI_Recommentations.html) that
482 483 484 485 486 487 488 489 490 491 492 493 494
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
```

495 496 497
## Clients

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

500 501
[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
502
[ce-3749]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3749
503
[ce-5951]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5951
504
[ce-9099]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9099
505
[pat]: ../user/profile/personal_access_tokens.md