BigW Consortium Gitlab

README.md 10.4 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 12
- [Users](users.md)
- [Session](session.md)
13
- [Projects](projects.md) including setting Webhooks
14
- [Project Snippets](project_snippets.md)
15
- [Services](services.md)
16 17 18
- [Repositories](repositories.md)
- [Repository Files](repository_files.md)
- [Commits](commits.md)
19
- [Tags](tags.md)
20 21 22
- [Branches](branches.md)
- [Merge Requests](merge_requests.md)
- [Issues](issues.md)
23
- [Labels](labels.md)
24 25 26 27 28
- [Milestones](milestones.md)
- [Notes](notes.md) (comments)
- [Deploy Keys](deploy_keys.md)
- [System Hooks](system_hooks.md)
- [Groups](groups.md)
29
- [Namespaces](namespaces.md)
30
- [Settings](settings.md)
31
- [Keys](keys.md)
Tomasz Maczukin committed
32
- [Builds](builds.md)
33
- [Build triggers](build_triggers.md)
34
- [Build Variables](build_variables.md)
35
- [Runners](runners.md)
36
- [Licenses](licenses.md)
37

38
## Authentication
39

40
All API requests require authentication. You need to pass a `private_token`
41 42 43
parameter via query string or header. If passed as a header, the header name
must be `PRIVATE-TOKEN` (uppercase and with a dash instead of an underscore).
You can find or reset your private token in your account page (`/profile/account`).
44

45 46
If `private_token` is invalid or omitted, then an error message will be
returned with status code `401`:
47 48 49 50 51 52 53

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

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

57
Example of a valid API request:
58

59 60
```shell
GET https://gitlab.example.com/api/v3/projects?private_token=9koXpg98eAheJpvBs5tK
61 62
```

63
Example of a valid API request using cURL and authentication via header:
64

65 66
```shell
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects"
67 68
```

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

72 73
## Authentication with OAuth2 token

74 75
Instead of the `private_token` you can transmit the OAuth2 access token as a
header or as a parameter.
76

77
Example of OAuth2 token as a parameter:
78

79 80
```shell
curl https://gitlab.example.com/api/v3/user?access_token=OAUTH-TOKEN
81 82
```

83
Example of OAuth2 token as a header:
84

85 86
```shell
curl -H "Authorization: Bearer OAUTH-TOKEN" https://example.com/api/v3/user
87 88
```

89
Read more about [GitLab as an OAuth2 client](oauth2.md).
90

91 92
## Status codes

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

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

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

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

108
| Return values | Description |
109 110 111
| ------------- | ----------- |
| `200 OK` | The `GET`, `PUT` or `DELETE` request was successful, the resource(s) itself is returned as JSON. |
| `201 Created` | The `POST` request was successful and the resource is returned as JSON. |
112
| `304 Not Modified` | Indicates that the resource has not been modified since the last request. |
113
| `400 Bad Request` | A required attribute of the API request is missing, e.g., the title of an issue is not given. |
114
| `401 Unauthorized` | The user is not authenticated, a valid [user token](#authentication) is necessary. |
115 116
| `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. |
117
| `405 Method Not Allowed` | The request is not supported. |
118
| `409 Conflict` | A conflicting resource already exists, e.g., creating a project with a name that already exists. |
119
| `422 Unprocessable` | The entity could not be processed. |
120
| `500 Server Error` | While handling the request something went wrong server-side. |
121

122
## Sudo
123

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

130 131
If a non administrative `private_token` is provided, then an error message will
be returned with status code `403`:
132 133 134 135 136 137 138

```json
{
  "message": "403 Forbidden: Must be admin to use sudo"
}
```

139
If the sudo user ID or username cannot be found, an error message will be
140
returned with status code `404`:
141 142 143 144 145 146 147

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

148 149 150 151
---

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

153 154
```shell
GET /projects?private_token=9koXpg98eAheJpvBs5tK&sudo=username
155
```
156

157
```shell
158
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --header "SUDO: username" "https://gitlab.example.com/api/v3/projects"
159 160
```

161 162
Example of a valid API call and a request using cURL with sudo request,
providing an ID:
163

164
```shell
165
GET /projects?private_token=9koXpg98eAheJpvBs5tK&sudo=23
166
```
167

168 169
```shell
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --header "SUDO: 23" "https://gitlab.example.com/api/v3/projects"
170
```
171

Dmitriy Zaporozhets committed
172
## Pagination
Nihad Abbasov committed
173

174 175
Sometimes the returned result will span across many pages. When listing
resources you can pass the following parameters:
Nihad Abbasov committed
176

177 178
| Parameter | Description |
| --------- | ----------- |
179 180
| `page`    | Page number (default: `1`) |
| `per_page`| Number of items to list per page (default: `20`, max: `100`) |
Nihad Abbasov committed
181

182 183 184 185 186 187
In the example below, we list 50 [namespaces](namespaces.md) per page.

```bash
curl -X PUT -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/namespaces?per_page=50
```

188
### Pagination Link header
189

190
[Link headers](http://www.w3.org/wiki/LinkHeader) are sent back with each
191 192
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.
193

194 195 196 197 198 199
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
curl -I -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/8/issues/8/notes?per_page=3&page=2
200 201
```

202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
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
Link: <https://gitlab.example.com/api/v3/projects/8/issues/8/notes?page=1&per_page=3>; rel="prev", <https://gitlab.example.com/api/v3/projects/8/issues/8/notes?page=3&per_page=3>; rel="next", <https://gitlab.example.com/api/v3/projects/8/issues/8/notes?page=1&per_page=3>; rel="first", <https://gitlab.example.com/api/v3/projects/8/issues/8/notes?page=3&per_page=3>; rel="last"
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
221 222 223 224
```

### Other pagination headers

225 226 227 228 229 230 231 232 233 234
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 |
235

236
## `id` vs `iid`
Dmitriy Zaporozhets committed
237

238 239 240 241
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`.
242

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

248
That means that if you want to get an issue via the API you should use the `id`:
249 250

```bash
251
GET /projects/42/issues/:id
252
```
Dmitriy Zaporozhets committed
253

254 255
On the other hand, if you want to create a link to a web page you should use
the `iid`:
Dmitriy Zaporozhets committed
256

257
```bash
258
GET /projects/42/issues/:iid
259
```
260 261 262

## Data validation and error reporting

263
When working with the API you may encounter validation errors, in which case
264 265
the API will answer with an HTTP `400` status.

266 267
Such errors appear in two cases:

268
- A required attribute of the API request is missing, e.g., the title of an
269
  issue is not given
270
- An attribute did not pass the validation, e.g., user bio is too long
271 272 273

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

274
```
275 276 277 278 279 280
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
    "message":"400 (Bad request) \"title\" not given"
}
```
281

282 283
When a validation error occurs, error messages will be different. They will
hold all details of validation errors:
284

285
```
286 287 288 289 290 291 292
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
    "message": {
        "bio": [
            "is too long (maximum is 255 characters)"
        ]
293
    }
294 295
}
```
296

297 298
This makes error messages more machine-readable. The format can be described as
follows:
299

300 301 302 303 304 305 306 307 308
```json
{
    "message": {
        "<property-name>": [
            "<error-message>",
            "<error-message>",
            ...
        ],
        "<embed-entity>": {
309 310 311 312 313 314 315
            "<property-name>": [
                "<error-message>",
                "<error-message>",
                ...
            ],
        }
    }
316 317 318 319 320 321
}
```

## Clients

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

324 325
[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