BigW Consortium Gitlab

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

36
## Authentication
37

38
All API requests require authentication. You need to pass a `private_token`
39 40 41
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`).
42

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

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

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

55
Example of a valid API request:
56

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

61
Example of a valid API request using cURL and authentication via header:
62

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

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

70 71
## Authentication with OAuth2 token

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

75
Example of OAuth2 token as a parameter:
76

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

81
Example of OAuth2 token as a header:
82

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

87
Read more about [GitLab as an OAuth2 client](oauth2.md).
88

89 90
## Status codes

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

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

97
| Request type | Description |
98 99 100 101
| ------------ | ----------- |
| `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. |
102
| `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. |
103 104 105

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

106
| Return values | Description |
107 108 109
| ------------- | ----------- |
| `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. |
110
| `400 Bad Request` | A required attribute of the API request is missing, e.g., the title of an issue is not given. |
111
| `401 Unauthorized` | The user is not authenticated, a valid [user token](#authentication) is necessary. |
112 113
| `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. |
114
| `405 Method Not Allowed` | The request is not supported. |
115
| `409 Conflict` | A conflicting resource already exists, e.g., creating a project with a name that already exists. |
116
| `422 Unprocessable` | The entity could not be processed. |
117
| `500 Server Error` | While handling the request something went wrong server-side. |
118

119
## Sudo
120

121
All API requests support performing an API call as if you were another user,
122
provided your private token is from an administrator account. You need to pass
123 124 125
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).
126

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

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

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

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

145 146 147 148
---

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

150 151
```shell
GET /projects?private_token=9koXpg98eAheJpvBs5tK&sudo=username
152
```
153

154
```shell
155
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --header "SUDO: username" "https://gitlab.example.com/api/v3/projects"
156 157
```

158 159
Example of a valid API call and a request using cURL with sudo request,
providing an ID:
160

161
```shell
162
GET /projects?private_token=9koXpg98eAheJpvBs5tK&sudo=23
163
```
164

165 166
```shell
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --header "SUDO: 23" "https://gitlab.example.com/api/v3/projects"
167
```
168

Dmitriy Zaporozhets committed
169
## Pagination
Nihad Abbasov committed
170

171 172
Sometimes the returned result will span across many pages. When listing
resources you can pass the following parameters:
Nihad Abbasov committed
173

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

179 180 181 182 183 184
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
```

185
### Pagination Link header
186

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

191 192 193 194 195 196
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
197 198
```

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
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
218 219 220 221
```

### Other pagination headers

222 223 224 225 226 227 228 229 230 231
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 |
232

233
## `id` vs `iid`
Dmitriy Zaporozhets committed
234

235 236 237 238
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`.
239

240 241
| Parameter | Description |
| --------- | ----------- |
242 243
| `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
244

245
That means that if you want to get an issue via the API you should use the `id`:
246 247

```bash
248
GET /projects/42/issues/:id
249
```
Dmitriy Zaporozhets committed
250

251 252
On the other hand, if you want to create a link to a web page you should use
the `iid`:
Dmitriy Zaporozhets committed
253

254
```bash
255
GET /projects/42/issues/:iid
256
```
257 258 259

## Data validation and error reporting

260
When working with the API you may encounter validation errors, in which case
261 262
the API will answer with an HTTP `400` status.

263 264
Such errors appear in two cases:

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

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

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

279 280
When a validation error occurs, error messages will be different. They will
hold all details of validation errors:
281

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

294 295
This makes error messages more machine-readable. The format can be described as
follows:
296

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

## Clients

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

321 322
[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