README.md 21.4 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 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.

Evan Read's avatar
Evan Read committed
8
## API Resources
9

Evan Read's avatar
Evan Read committed
10
The following API resources are available:
11

Evan Read's avatar
Evan Read committed
12 13 14
- [Applications](applications.md)
- [Avatar](avatar.md)
- [Award emoji](award_emoji.md)
15
- [Branches](branches.md)
Evan Read's avatar
Evan Read committed
16 17
- [Broadcast messages](broadcast_messages.md)
- [Code snippets](snippets.md)
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
18
- [Commits](commits.md)
19
- [Container Registry](container_registry.md)
Evan Read's avatar
Evan Read committed
20 21
- [Custom attributes](custom_attributes.md)
- [Deploy keys](deploy_keys.md), and [deploy keys for multiple projects](deploy_key_multiple_projects.md)
22
- [Deployments](deployments.md)
Evan Read's avatar
Evan Read committed
23
- [Discussions](discussions.md) (threaded comments)
24
- [Environments](environments.md)
Mark Fletcher's avatar
Mark Fletcher committed
25
- [Events](events.md)
Rémy Coutable's avatar
Rémy Coutable committed
26
- [Feature flags](features.md)
Evan Read's avatar
Evan Read committed
27 28 29 30 31 32 33 34
- Group-related resources, including:
  - [Groups](groups.md)
  - [Group access requests](access_requests.md)
  - [Group badges](group_badges.md)
  - [Group issue boards](group_boards.md)
  - [Group-level variables](group_level_variables.md)
  - [Group members](members.md)
  - [Group milestones](group_milestones.md)
35
- [Issues](issues.md)
Evan Read's avatar
Evan Read committed
36
- [Issue boards](boards.md)
37
- [Jobs](jobs.md)
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
38
- [Keys](keys.md)
39
- [Labels](labels.md)
40
- [Markdown](markdown.md)
Evan Read's avatar
Evan Read committed
41
- [Merge requests](merge_requests.md)
42
- [Namespaces](namespaces.md)
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
43
- [Notes](notes.md) (comments)
44
- [Notification settings](notification_settings.md)
Evan Read's avatar
Evan Read committed
45
- [Pages domains](pages_domains.md)
46
- [Pipelines](pipelines.md)
Evan Read's avatar
Evan Read committed
47 48 49 50 51 52
- [Pipeline schedules](pipeline_schedules.md)
- [Pipeline triggers](pipeline_triggers.md) and [triggering pipelines](../ci/triggers/README.md)
- Project-related resources, including:
  - [Projects](projects.md) including setting Webhooks
  - [Project access requests](access_requests.md)
  - [Project badges](project_badges.md)
53
  - [Project clusters](project_clusters.md)
Evan Read's avatar
Evan Read committed
54 55 56 57 58 59 60 61
  - [Project-level variables](project_level_variables.md)
  - [Project import/export](project_import_export.md)
  - [Project members](members.md)
  - [Project milestones](milestones.md)
  - [Project snippets](project_snippets.md)
  - [Project templates](project_templates.md) (see also [Templates API Resources](#templates-api-resources))
- [Protected branches](protected_branches.md)
- [Protected tags](protected_tags.md)
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
62
- [Repositories](repositories.md)
Evan Read's avatar
Evan Read committed
63 64 65
- [Repository files](repository_files.md)
- [Repository submodules](repository_submodules.md)
- [Resource label events](resource_label_events.md)
66
- [Runners](runners.md)
67
- [Search](search.md)
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
68 69
- [Services](services.md)
- [Settings](settings.md)
70
- [Sidekiq metrics](sidekiq_metrics.md)
Evan Read's avatar
Evan Read committed
71
- [System hooks](system_hooks.md)
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
72
- [Tags](tags.md)
73 74 75
- [Releases](releases/index.md)
- Release Assets
  - [Links](releases/links.md)
76
- [Todos](todos.md)
77
- [Users](users.md)
Evan Read's avatar
Evan Read committed
78
- [Validate CI configuration](lint.md) (linting)
Robert Schilling's avatar
Robert Schilling committed
79
- [Version](version.md)
blackst0ne's avatar
blackst0ne committed
80
- [Wikis](wikis.md)
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
81

Evan Read's avatar
Evan Read committed
82 83 84 85 86 87 88 89 90 91 92
See also [V3 to V4](v3_to_v4.md).

### Templates API Resources

Endpoints are available for:

- [Dockerfile templates](templates/dockerfiles.md).
- [gitignore templates](templates/gitignores.md).
- [GitLab CI YAML templates](templates/gitlab_ci_ymls.md).
- [Open source license templates](templates/licenses.md).

93 94
## Road to GraphQL

95 96 97 98 99
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.
100 101
1. Callers of the API can request only what they need.
1. It is versioned by default.
102 103 104 105 106 107 108 109

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

111 112 113
## Compatibility Guidelines

The HTTP API is versioned using a single number, the current one being 4. This
Evan Read's avatar
Evan Read committed
114
number symbolizes the same as the major version number as described by
115 116
[SemVer](https://semver.org/). This mean that backward incompatible changes
will require this version number to change. However, the minor version is
117
not explicit. This allows for a stable API endpoint, but also means new
118 119 120
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
Bruce Szalwinski's avatar
Bruce Szalwinski committed
121
from incidental patch and security releases, are released on the 22nd of each
122 123 124 125
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
126 127
between v3 and v4; please read the [v3 to v4 documentation](v3_to_v4.md)

128
### Current status
129

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

133 134 135
## Basic usage

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

Douwe Maan's avatar
Douwe Maan committed
139
Example of a valid API request using cURL:
140 141

```shell
Douwe Maan's avatar
Douwe Maan committed
142
curl "https://gitlab.example.com/api/v4/projects"
143 144 145 146 147
```

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

148
## Authentication
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
149

Douwe Maan's avatar
Douwe Maan committed
150 151
Most API requests require authentication, or will only return public data when
authentication is not provided. For
152 153
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).
154

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

157 158
1. [OAuth2 tokens](#oauth2-tokens)
1. [Personal access tokens](#personal-access-tokens)
Douwe Maan's avatar
Douwe Maan committed
159 160 161
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:
162

Douwe Maan's avatar
Douwe Maan committed
163
1. [Impersonation tokens](#impersonation-tokens)
164
1. [Sudo](#sudo)
Nihad Abbasov's avatar
Nihad Abbasov committed
165

166 167
If authentication information is invalid or omitted, an error message will be
returned with status code `401`:
Nihad Abbasov's avatar
Nihad Abbasov committed
168 169 170 171 172 173 174

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

Douwe Maan's avatar
Douwe Maan committed
175
### OAuth2 tokens
176

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

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

Douwe Maan's avatar
Douwe Maan committed
182 183 184
```shell
curl https://gitlab.example.com/api/v4/projects?access_token=OAUTH-TOKEN
```
185

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

188
```shell
189
curl --header "Authorization: Bearer OAUTH-TOKEN" https://gitlab.example.com/api/v4/projects
190 191
```

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

Douwe Maan's avatar
Douwe Maan committed
194
### Personal access tokens
Nihad Abbasov's avatar
Nihad Abbasov committed
195

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

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

Douwe Maan's avatar
Douwe Maan committed
201
```shell
202
curl https://gitlab.example.com/api/v4/projects?private_token=<your_access_token>
Douwe Maan's avatar
Douwe Maan committed
203 204 205
```

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

Douwe Maan's avatar
Douwe Maan committed
207
```shell
208
curl --header "Private-Token: <your_access_token>" https://gitlab.example.com/api/v4/projects
Douwe Maan's avatar
Douwe Maan committed
209
```
210

Douwe Maan's avatar
Douwe Maan committed
211 212 213 214 215 216 217
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.
218

Douwe Maan's avatar
Douwe Maan committed
219 220 221
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.
222

223
### Impersonation tokens
224

225
> [Introduced][ce-9099] in GitLab 9.0. Needs admin permissions.
226

227
Impersonation tokens are a type of [personal access token][pat]
Douwe Maan's avatar
Douwe Maan committed
228 229
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.
230

Douwe Maan's avatar
Douwe Maan committed
231 232 233
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.
234

235
For more information, refer to the
236
[users API](users.md#retrieve-user-impersonation-tokens) docs.
237

Douwe Maan's avatar
Douwe Maan committed
238 239
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.
240

241 242 243 244 245
#### Disable impersonation

> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/40385) in GitLab
11.6.

246
By default, impersonation is enabled. To disable impersonation:
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276

**For Omnibus installations**

1. Edit `/etc/gitlab/gitlab.rb`:

    ```ruby
    gitlab_rails['impersonation_enabled'] = false
    ```

1. Save the file and [reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure)
   GitLab for the changes to take effect.

To re-enable impersonation, remove this configuration and reconfigure GitLab.

---

**For installations from source**

1. Edit `config/gitlab.yml`:

    ```yaml
    gitlab:
      impersonation_enabled: false
    ```

1. Save the file and [restart](../administration/restart_gitlab.md#installations-from-source)
   GitLab for the changes to take effect.

To re-enable impersonation, remove this configuration and restart GitLab.

277
### Sudo
278

279
NOTE: **Note:**
280
Only available to [administrators](../user/permissions.md).
281

282
All API requests support performing an API call as if you were another user,
Douwe Maan's avatar
Douwe Maan committed
283 284 285
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
286
the user you want to perform the operation as. If passed as a header, the
287
header name must be `Sudo`.
288 289 290

NOTE: **Note:**
Usernames are case insensitive.
291

Douwe Maan's avatar
Douwe Maan committed
292
If a non administrative access token is provided, an error message will
293
be returned with status code `403`:
294 295 296

```json
{
297
  "message": "403 Forbidden - Must be admin to use sudo"
298 299 300
}
```

Douwe Maan's avatar
Douwe Maan committed
301 302 303 304 305 306 307 308 309 310 311
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"
}
```

312
If the sudo user ID or username cannot be found, an error message will be
313
returned with status code `404`:
314 315 316

```json
{
Douwe Maan's avatar
Douwe Maan committed
317
  "message": "404 User with ID or username '123' Not Found"
318 319 320
}
```

321 322 323 324
---

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

326
```
327
GET /projects?private_token=<your_access_token>&sudo=username
328
```
329

330
```shell
331
curl --header "Private-Token: <your_access_token>" --header "Sudo: username" "https://gitlab.example.com/api/v4/projects"
332 333
```

334 335
Example of a valid API call and a request using cURL with sudo request,
providing an ID:
336

337
```
338
GET /projects?private_token=<your_access_token>&sudo=23
339
```
340

341
```shell
342
curl --header "Private-Token: <your_access_token>" --header "Sudo: 23" "https://gitlab.example.com/api/v4/projects"
343
```
344

345 346 347 348 349 350 351 352 353 354 355 356
## 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. |
357
| `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
358
| `DELETE` | Returns `204 No Content` if the resource was deleted successfully. |
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373

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
374
| `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. |
375 376
| `422 Unprocessable` | The entity could not be processed. |
| `500 Server Error` | While handling the request something went wrong server-side. |
377

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
378
## Pagination
Nihad Abbasov's avatar
Nihad Abbasov committed
379

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

383 384
| Parameter | Description |
| --------- | ----------- |
385 386
| `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
387

388 389 390
In the example below, we list 50 [namespaces](namespaces.md) per page.

```bash
391
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/namespaces?per_page=50
392 393
```

394
### Pagination Link header
395

396
[Link headers](http://www.w3.org/wiki/LinkHeader) are sent back with each
397 398
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.
399

400 401 402 403 404
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
405
curl --head --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/8/issues/8/notes?per_page=3&page=2
406 407
```

408 409 410 411 412 413 414 415
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
416
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"
417 418 419 420 421 422 423 424 425 426
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
427 428 429 430
```

### Other pagination headers

431 432 433 434 435 436 437 438 439 440
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 |
441

442 443
CAUTION: **Caution:**
For performance reasons since
Cynthia Ng's avatar
Cynthia Ng committed
444
[GitLab 11.8](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/23931)
445 446 447 448 449
and **behind the `api_kaminari_count_with_limit`
[feature flag](../development/feature_flags.md)**, if the number of resources is
more than 10,000, the `X-Total` and `X-Total-Pages` headers as well as the
`rel="last"` `Link` are not present in the response headers.

450 451
## Namespaced path encoding

452
If using namespaced API calls, make sure that the `NAMESPACE/PROJECT_NAME` is
453 454
URL-encoded.

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

```
458 459 460
GET /api/v4/projects/diaspora%2Fdiaspora
```

461
## Branches and tags name encoding
462 463 464 465 466 467 468 469

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
470 471
```

472 473
## Encoding API parameters of `array` and `hash` types

474
We can call the API with `array` and `hash` types parameters as shown below:
475 476 477 478 479

### `array`

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

480
```bash
481
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
482 483 484 485 486 487 488 489 490
-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`:

491
```bash
492
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
493 494 495 496 497 498 499 500
--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
```

501 502 503 504 505 506 507 508 509 510 511 512 513 514
### 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"
```

515
## `id` vs `iid`
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
516

517
 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:
518

519 520
- `id`: ID that is unique across all projects.
- `iid`: additional, internal ID that is unique in the scope of a single project.
521

522 523
NOTE: **Note:**
The `iid` is displayed in the web UI.
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
524

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

527
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
528

529 530
- 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
531

532
NOTE: **Note:**
533
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.
534 535 536

## Data validation and error reporting

537
When working with the API you may encounter validation errors, in which case
538 539
the API will answer with an HTTP `400` status.

540 541
Such errors appear in two cases:

542
- A required attribute of the API request is missing, e.g., the title of an
543
  issue is not given
544
- An attribute did not pass the validation, e.g., user bio is too long
545 546 547

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

548
```
549 550 551 552 553 554
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
    "message":"400 (Bad request) \"title\" not given"
}
```
555

556 557
When a validation error occurs, error messages will be different. They will
hold all details of validation errors:
558

559
```
560 561 562 563 564 565 566
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
    "message": {
        "bio": [
            "is too long (maximum is 255 characters)"
        ]
567
    }
568 569
}
```
570

571 572
This makes error messages more machine-readable. The format can be described as
follows:
573

574 575 576 577 578 579 580 581 582
```json
{
    "message": {
        "<property-name>": [
            "<error-message>",
            "<error-message>",
            ...
        ],
        "<embed-entity>": {
583 584 585 586 587 588 589
            "<property-name>": [
                "<error-message>",
                "<error-message>",
                ...
            ],
        }
    }
590 591 592
}
```

593
## Unknown route
594

595
When you try to access an API URL that does not exist you will receive 404 Not Found.
596 597

```
598
HTTP/1.1 404 Not Found
599
Content-Type: application/json
600
{
601
    "error": "404 Not Found"
602 603 604
}
```

605 606 607
## Encoding `+` in ISO 8601 dates

If you need to include a `+` in a query parameter, you may need to use `%2B` instead due
Cynthia Ng's avatar
Cynthia Ng committed
608
to a [W3 recommendation](http://www.w3.org/Addressing/URL/4_URI_Recommentations.html) that
609 610 611 612 613 614 615 616 617 618 619 620 621
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
```

622 623 624
## Clients

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

627 628
[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
629
[ce-3749]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3749
630
[ce-5951]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5951
631
[ce-9099]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9099
632
[pat]: ../user/profile/personal_access_tokens.md