BigW Consortium Gitlab

projects.md 30.4 KB
Newer Older
1
# Projects
2

3 4 5 6

### Project visibility level

Project in GitLab has be either private, internal or public.
7
You can determine it by `visibility_level` field in project.
8 9 10

Constants for project visibility levels are next:

11
* Private. `visibility_level` is `0`.
12 13 14 15
  Project access must be granted explicitly for each user.

* Internal. `visibility_level` is `10`.
  The project can be cloned by any logged in user.
16

17 18 19 20
* Public. `visibility_level` is `20`.
  The project can be cloned without any authentication.


21
## List projects
22

23
Get a list of projects accessible by the authenticated user.
24 25 26 27 28

```
GET /projects
```

29 30
Parameters:

31
- `archived` (optional) - if passed, limit by archived status
32
- `visibility` (optional) - if passed, limit by visibility `public`, `internal`, `private`
33 34
- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
35
- `search` (optional) - Return list of authorized projects according to a search criteria
36

37 38 39
```json
[
  {
40
    "id": 4,
41 42
    "description": null,
    "default_branch": "master",
43
    "public": false,
44
    "visibility_level": 0,
45 46 47
    "ssh_url_to_repo": "git@example.com:diaspora/diaspora-client.git",
    "http_url_to_repo": "http://example.com/diaspora/diaspora-client.git",
    "web_url": "http://example.com/diaspora/diaspora-client",
48 49 50 51
    "tag_list": [
      "example",
      "disapora client"
    ],
52
    "owner": {
53 54 55
      "id": 3,
      "name": "Diaspora",
      "created_at": "2013-09-30T13: 46: 02Z"
56
    },
57 58 59 60 61
    "name": "Diaspora Client",
    "name_with_namespace": "Diaspora / Diaspora Client",
    "path": "diaspora-client",
    "path_with_namespace": "diaspora/diaspora-client",
    "issues_enabled": true,
62
    "open_issues_count": 1,
63
    "merge_requests_enabled": true,
64
    "builds_enabled": true,
65
    "wiki_enabled": true,
66 67 68
    "snippets_enabled": false,
    "created_at": "2013-09-30T13: 46: 02Z",
    "last_activity_at": "2013-09-30T13: 46: 02Z",
69
    "creator_id": 3,
70 71 72 73 74 75 76 77
    "namespace": {
      "created_at": "2013-09-30T13: 46: 02Z",
      "description": "",
      "id": 3,
      "name": "Diaspora",
      "owner_id": 1,
      "path": "diaspora",
      "updated_at": "2013-09-30T13: 46: 02Z"
78
    },
79
    "archived": false,
Tomasz Maczukin committed
80 81 82
    "avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png",
    "shared_runners_enabled": true,
    "forks_count": 0,
83 84
    "star_count": 0,
    "runners_token": "b8547b1dc37721d05889db52fa2f02",
85
    "public_builds": true
86 87
  },
  {
88
    "id": 6,
89
    "description": null,
90 91
    "default_branch": "master",
    "public": false,
92
    "visibility_level": 0,
93 94 95
    "ssh_url_to_repo": "git@example.com:brightbox/puppet.git",
    "http_url_to_repo": "http://example.com/brightbox/puppet.git",
    "web_url": "http://example.com/brightbox/puppet",
96 97 98 99
    "tag_list": [
      "example",
      "puppet"
    ],
100
    "owner": {
101 102 103
      "id": 4,
      "name": "Brightbox",
      "created_at": "2013-09-30T13:46:02Z"
104
    },
105 106 107 108
    "name": "Puppet",
    "name_with_namespace": "Brightbox / Puppet",
    "path": "puppet",
    "path_with_namespace": "brightbox/puppet",
109
    "issues_enabled": true,
110
    "open_issues_count": 1,
111
    "merge_requests_enabled": true,
112
    "builds_enabled": true,
113
    "wiki_enabled": true,
114 115 116
    "snippets_enabled": false,
    "created_at": "2013-09-30T13:46:02Z",
    "last_activity_at": "2013-09-30T13:46:02Z",
117
    "creator_id": 3,
118
    "namespace": {
119 120 121 122 123 124 125
      "created_at": "2013-09-30T13:46:02Z",
      "description": "",
      "id": 4,
      "name": "Brightbox",
      "owner_id": 1,
      "path": "brightbox",
      "updated_at": "2013-09-30T13:46:02Z"
126
    },
127 128 129 130 131 132 133 134 135 136
    "permissions": {
      "project_access": {
        "access_level": 10,
        "notification_level": 3
      },
      "group_access": {
        "access_level": 50,
        "notification_level": 3
      }
    },
137
    "archived": false,
Tomasz Maczukin committed
138 139 140 141
    "avatar_url": null,
    "shared_runners_enabled": true,
    "forks_count": 0,
    "star_count": 0,
142
    "runners_token": "b8547b1dc37721d05889db52fa2f02",
143
    "public_builds": true
144 145 146 147
  }
]
```

148
### List owned projects
149

150
Get a list of projects which are owned by the authenticated user.
151 152 153 154 155

```
GET /projects/owned
```

156 157 158
Parameters:

- `archived` (optional) - if passed, limit by archived status
159
- `visibility` (optional) - if passed, limit by visibility `public`, `internal`, `private`
160 161
- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
162 163 164 165 166 167 168 169 170 171 172 173 174
- `search` (optional) - Return list of authorized projects according to a search criteria

### List starred projects

Get a list of projects which are starred by the authenticated user.

```
GET /projects/starred
```

Parameters:

- `archived` (optional) - if passed, limit by archived status
175
- `visibility` (optional) - if passed, limit by visibility `public`, `internal`, `private`
176 177
- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
178 179
- `search` (optional) - Return list of authorized projects according to a search criteria

180
### List ALL projects
181 182 183 184 185 186 187

Get a list of all GitLab projects (admin only).

```
GET /projects/all
```

188 189 190
Parameters:

- `archived` (optional) - if passed, limit by archived status
191
- `visibility` (optional) - if passed, limit by visibility `public`, `internal`, `private`
192 193 194 195
- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
- `search` (optional) - Return list of authorized projects according to a search criteria

196
### Get single project
197

198
Get a specific project, identified by project ID or NAMESPACE/PROJECT_NAME, which is owned by the authenticated user.
Marin Jankovski committed
199
If using namespaced projects call make sure that the NAMESPACE/PROJECT_NAME is URL-encoded, eg. `/api/v3/projects/diaspora%2Fdiaspora` (where `/` is represented by `%2F`).
200 201 202 203 204 205 206

```
GET /projects/:id
```

Parameters:

207
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
208

209 210
```json
{
211
  "id": 3,
212
  "description": null,
213 214
  "default_branch": "master",
  "public": false,
215
  "visibility_level": 0,
216 217 218
  "ssh_url_to_repo": "git@example.com:diaspora/diaspora-project-site.git",
  "http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
  "web_url": "http://example.com/diaspora/diaspora-project-site",
219 220 221 222
  "tag_list": [
    "example",
    "disapora project"
  ],
223
  "owner": {
224 225 226
    "id": 3,
    "name": "Diaspora",
    "created_at": "2013-09-30T13: 46: 02Z"
227
  },
228 229 230 231
  "name": "Diaspora Project Site",
  "name_with_namespace": "Diaspora / Diaspora Project Site",
  "path": "diaspora-project-site",
  "path_with_namespace": "diaspora/diaspora-project-site",
232
  "issues_enabled": true,
233
  "open_issues_count": 1,
234
  "merge_requests_enabled": true,
235
  "builds_enabled": true,
236
  "wiki_enabled": true,
237 238 239
  "snippets_enabled": false,
  "created_at": "2013-09-30T13: 46: 02Z",
  "last_activity_at": "2013-09-30T13: 46: 02Z",
240
  "creator_id": 3,
241 242 243 244 245 246 247 248
  "namespace": {
    "created_at": "2013-09-30T13: 46: 02Z",
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
    "updated_at": "2013-09-30T13: 46: 02Z"
249
  },
Dmitriy Zaporozhets committed
250 251 252 253 254 255 256 257 258
  "permissions": {
    "project_access": {
      "access_level": 10,
      "notification_level": 3
    },
    "group_access": {
      "access_level": 50,
      "notification_level": 3
    }
259
  },
260
  "archived": false,
Tomasz Maczukin committed
261 262 263 264 265
  "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
  "shared_runners_enabled": true,
  "forks_count": 0,
  "star_count": 0,
  "runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b"
266 267 268
}
```

269 270
### Get project events

271
Get the events for the specified project.
272 273 274 275 276 277 278 279
Sorted from newest to latest

```
GET /projects/:id/events
```

Parameters:

280
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
281 282

```json
283 284 285 286 287 288 289 290 291
[
  {
    "title": null,
    "project_id": 15,
    "action_name": "closed",
    "target_id": 830,
    "target_type": "Issue",
    "author_id": 1,
    "data": null,
292 293 294 295 296 297 298 299 300 301
    "target_title": "Public project search field",
    "author": {
      "name": "Dmitriy Zaporozhets",
      "username": "root",
      "id": 1,
      "state": "active",
      "avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
      "web_url": "http://localhost:3000/u/root"
    },
    "author_username": "root"
302 303 304 305 306 307 308 309
  },
  {
    "title": null,
    "project_id": 15,
    "action_name": "opened",
    "target_id": null,
    "target_type": null,
    "author_id": 1,
310 311 312 313 314 315 316 317
    "author": {
      "name": "Dmitriy Zaporozhets",
      "username": "root",
      "id": 1,
      "state": "active",
      "avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
      "web_url": "http://localhost:3000/u/root"
    },
318
    "author_username": "john",
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
    "data": {
      "before": "50d4420237a9de7be1304607147aec22e4a14af7",
      "after": "c5feabde2d8cd023215af4d2ceeb7a64839fc428",
      "ref": "refs/heads/master",
      "user_id": 1,
      "user_name": "Dmitriy Zaporozhets",
      "repository": {
        "name": "gitlabhq",
        "url": "git@dev.gitlab.org:gitlab/gitlabhq.git",
        "description": "GitLab: self hosted Git management software. \r\nDistributed under the MIT License.",
        "homepage": "https://dev.gitlab.org/gitlab/gitlabhq"
      },
      "commits": [
        {
          "id": "c5feabde2d8cd023215af4d2ceeb7a64839fc428",
          "message": "Add simple search to projects in public area",
          "timestamp": "2013-05-13T18:18:08+00:00",
          "url": "https://dev.gitlab.org/gitlab/gitlabhq/commit/c5feabde2d8cd023215af4d2ceeb7a64839fc428",
          "author": {
            "name": "Dmitriy Zaporozhets",
            "email": "dmitriy.zaporozhets@gmail.com"
          }
        }
      ],
      "total_commits_count": 1
344
    },
345
    "target_title": null
346
  },
347 348 349 350 351 352 353 354
  {
    "title": null,
    "project_id": 15,
    "action_name": "closed",
    "target_id": 840,
    "target_type": "Issue",
    "author_id": 1,
    "data": null,
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
    "target_title": "Finish & merge Code search PR",
    "author": {
      "name": "Dmitriy Zaporozhets",
      "username": "root",
      "id": 1,
      "state": "active",
      "avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
      "web_url": "http://localhost:3000/u/root"
    },
    "author_username": "root"
  },
  {
    "title": null,
    "project_id": 15,
    "action_name": "commented on",
    "target_id": 1312,
    "target_type": "Note",
    "author_id": 1,
    "data": null,
    "target_title": null,
    "created_at": "2015-12-04T10:33:58.089Z",
    "note": {
      "id": 1312,
      "body": "What an awesome day!",
      "attachment": null,
      "author": {
        "name": "Dmitriy Zaporozhets",
        "username": "root",
        "id": 1,
        "state": "active",
        "avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
        "web_url": "http://localhost:3000/u/root"
      },
      "created_at": "2015-12-04T10:33:56.698Z",
      "system": false,
      "upvote": false,
      "downvote": false,
      "noteable_id": 377,
      "noteable_type": "Issue"
    },
    "author": {
      "name": "Dmitriy Zaporozhets",
      "username": "root",
      "id": 1,
      "state": "active",
      "avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
      "web_url": "http://localhost:3000/u/root"
    },
    "author_username": "root"
404 405
  }
]
406 407
```

408
### Create project
409

410
Creates a new project owned by the authenticated user.
411 412 413 414 415 416 417

```
POST /projects
```

Parameters:

418
- `name` (required) - new project name
419
- `path` (optional) - custom repository name for new project. By default generated based on name
420 421 422 423
- `namespace_id` (optional) - namespace for the new project (defaults to user)
- `description` (optional) - short project description
- `issues_enabled` (optional)
- `merge_requests_enabled` (optional)
424
- `builds_enabled` (optional)
425 426 427 428 429
- `wiki_enabled` (optional)
- `snippets_enabled` (optional)
- `public` (optional) - if `true` same as setting visibility_level = 20
- `visibility_level` (optional)
- `import_url` (optional)
430
- `public_builds` (optional)
431

432 433
### Create project for user

434
Creates a new project owned by the specified user. Available only for admins.
435 436 437 438 439 440 441

```
POST /projects/user/:user_id
```

Parameters:

442 443 444 445 446
- `user_id` (required) - user_id of owner
- `name` (required) - new project name
- `description` (optional) - short project description
- `issues_enabled` (optional)
- `merge_requests_enabled` (optional)
447
- `builds_enabled` (optional)
448 449 450 451 452
- `wiki_enabled` (optional)
- `snippets_enabled` (optional)
- `public` (optional) - if `true` same as setting visibility_level = 20
- `visibility_level` (optional)
- `import_url` (optional)
453
- `public_builds` (optional)
454

455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
### Edit project

Updates an existing project

```
PUT /projects/:id
```

Parameters:

- `id` (required) - The ID of a project
- `name` (optional) - project name
- `path` (optional) - repository name for project
- `description` (optional) - short project description
- `default_branch` (optional)
- `issues_enabled` (optional)
- `merge_requests_enabled` (optional)
472
- `builds_enabled` (optional)
473 474 475 476
- `wiki_enabled` (optional)
- `snippets_enabled` (optional)
- `public` (optional) - if `true` same as setting visibility_level = 20
- `visibility_level` (optional)
477
- `public_builds` (optional)
478

479
On success, method returns 200 with the updated project. If parameters are
480 481
invalid, 400 is returned.

482 483 484 485 486 487 488 489 490 491 492 493
### Fork project

Forks a project into the user namespace of the authenticated user.

```
POST /projects/fork/:id
```

Parameters:

- `id` (required) - The ID of the project to be forked

494 495
### Star a project

496 497
Stars a given project. Returns status code `201` and the project on success and
`304` if the project is already starred.
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558

```
POST /projects/:id/star
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes | The ID of the project |

```bash
curl -X POST -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/star"
```

Example response:

```json
{
  "id": 3,
  "description": null,
  "default_branch": "master",
  "public": false,
  "visibility_level": 10,
  "ssh_url_to_repo": "git@example.com:diaspora/diaspora-project-site.git",
  "http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
  "web_url": "http://example.com/diaspora/diaspora-project-site",
  "tag_list": [
    "example",
    "disapora project"
  ],
  "name": "Diaspora Project Site",
  "name_with_namespace": "Diaspora / Diaspora Project Site",
  "path": "diaspora-project-site",
  "path_with_namespace": "diaspora/diaspora-project-site",
  "issues_enabled": true,
  "open_issues_count": 1,
  "merge_requests_enabled": true,
  "builds_enabled": true,
  "wiki_enabled": true,
  "snippets_enabled": false,
  "created_at": "2013-09-30T13: 46: 02Z",
  "last_activity_at": "2013-09-30T13: 46: 02Z",
  "creator_id": 3,
  "namespace": {
    "created_at": "2013-09-30T13: 46: 02Z",
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
    "updated_at": "2013-09-30T13: 46: 02Z"
  },
  "archived": true,
  "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
  "shared_runners_enabled": true,
  "forks_count": 0,
  "star_count": 1
}
```

### Unstar a project

559 560
Unstars a given project. Returns status code `200` and the project on success
and `304` if the project is not starred.
561 562

```
563
DELETE /projects/:id/star
564 565 566 567 568 569 570
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes | The ID of the project |

```bash
571
curl -X DELETE -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/star"
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
```

Example response:

```json
{
  "id": 3,
  "description": null,
  "default_branch": "master",
  "public": false,
  "visibility_level": 10,
  "ssh_url_to_repo": "git@example.com:diaspora/diaspora-project-site.git",
  "http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
  "web_url": "http://example.com/diaspora/diaspora-project-site",
  "tag_list": [
    "example",
    "disapora project"
  ],
  "name": "Diaspora Project Site",
  "name_with_namespace": "Diaspora / Diaspora Project Site",
  "path": "diaspora-project-site",
  "path_with_namespace": "diaspora/diaspora-project-site",
  "issues_enabled": true,
  "open_issues_count": 1,
  "merge_requests_enabled": true,
  "builds_enabled": true,
  "wiki_enabled": true,
  "snippets_enabled": false,
  "created_at": "2013-09-30T13: 46: 02Z",
  "last_activity_at": "2013-09-30T13: 46: 02Z",
  "creator_id": 3,
  "namespace": {
    "created_at": "2013-09-30T13: 46: 02Z",
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
    "updated_at": "2013-09-30T13: 46: 02Z"
  },
  "archived": true,
  "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
  "shared_runners_enabled": true,
  "forks_count": 0,
  "star_count": 0
}
```

620 621
### Archive a project

622
Archives the project if the user is either admin or the project owner of this project. This action is
623 624
idempotent, thus archiving an already archived project will not change the project.

625 626 627
Status code 201 with the project as body is given when successful, in case the user doesn't
have the proper access rights, code 403 is returned. Status 404 is returned if the project
doesn't exist, or is hidden to the user.
628 629

```
630
POST /projects/:id/archive
631 632 633 634 635 636 637
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes | The ID of the project |

```bash
638
curl -X POST -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/archive"
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
```

Example response:

```json
{
  "id": 3,
  "description": null,
  "default_branch": "master",
  "public": false,
  "visibility_level": 0,
  "ssh_url_to_repo": "git@example.com:diaspora/diaspora-project-site.git",
  "http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
  "web_url": "http://example.com/diaspora/diaspora-project-site",
  "tag_list": [
    "example",
    "disapora project"
  ],
  "owner": {
    "id": 3,
    "name": "Diaspora",
    "created_at": "2013-09-30T13: 46: 02Z"
  },
  "name": "Diaspora Project Site",
  "name_with_namespace": "Diaspora / Diaspora Project Site",
  "path": "diaspora-project-site",
  "path_with_namespace": "diaspora/diaspora-project-site",
  "issues_enabled": true,
  "open_issues_count": 1,
  "merge_requests_enabled": true,
  "builds_enabled": true,
  "wiki_enabled": true,
  "snippets_enabled": false,
  "created_at": "2013-09-30T13: 46: 02Z",
  "last_activity_at": "2013-09-30T13: 46: 02Z",
  "creator_id": 3,
  "namespace": {
    "created_at": "2013-09-30T13: 46: 02Z",
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
    "updated_at": "2013-09-30T13: 46: 02Z"
  },
  "permissions": {
    "project_access": {
      "access_level": 10,
      "notification_level": 3
    },
    "group_access": {
      "access_level": 50,
      "notification_level": 3
    }
  },
  "archived": true,
  "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
  "shared_runners_enabled": true,
  "forks_count": 0,
  "star_count": 0,
  "runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b"
}
```

### Unarchive a project

705
Unarchives the project if the user is either admin or the project owner of this project. This action is
706 707
idempotent, thus unarchiving an non-archived project will not change the project.

708 709 710
Status code 201 with the project as body is given when successful, in case the user doesn't
have the proper access rights, code 403 is returned. Status 404 is returned if the project
doesn't exist, or is hidden to the user.
711 712

```
713
POST /projects/:id/archive
714 715 716 717 718 719 720
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id`      | integer | yes | The ID of the project |

```bash
721
curl -X POST -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/unarchive"
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
```

Example response:

```json
{
  "id": 3,
  "description": null,
  "default_branch": "master",
  "public": false,
  "visibility_level": 0,
  "ssh_url_to_repo": "git@example.com:diaspora/diaspora-project-site.git",
  "http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
  "web_url": "http://example.com/diaspora/diaspora-project-site",
  "tag_list": [
    "example",
    "disapora project"
  ],
  "owner": {
    "id": 3,
    "name": "Diaspora",
    "created_at": "2013-09-30T13: 46: 02Z"
  },
  "name": "Diaspora Project Site",
  "name_with_namespace": "Diaspora / Diaspora Project Site",
  "path": "diaspora-project-site",
  "path_with_namespace": "diaspora/diaspora-project-site",
  "issues_enabled": true,
  "open_issues_count": 1,
  "merge_requests_enabled": true,
  "builds_enabled": true,
  "wiki_enabled": true,
  "snippets_enabled": false,
  "created_at": "2013-09-30T13: 46: 02Z",
  "last_activity_at": "2013-09-30T13: 46: 02Z",
  "creator_id": 3,
  "namespace": {
    "created_at": "2013-09-30T13: 46: 02Z",
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
    "updated_at": "2013-09-30T13: 46: 02Z"
  },
  "permissions": {
    "project_access": {
      "access_level": 10,
      "notification_level": 3
    },
    "group_access": {
      "access_level": 50,
      "notification_level": 3
    }
  },
  "archived": false,
  "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
  "shared_runners_enabled": true,
  "forks_count": 0,
  "star_count": 0,
  "runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b"
}
```

786
### Remove project
787

788
Removes a project including all associated resources (issues, merge requests etc.)
789 790 791 792 793 794 795

```
DELETE /projects/:id
```

Parameters:

796
- `id` (required) - The ID of a project
797

798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
## Uploads

### Upload a file

Uploads a file to the specified project to be used in an issue or merge request description, or a comment.

```
POST /projects/:id/uploads
```

Parameters:

- `id` (required) - The ID of the project
- `file` (required) - The file to be uploaded

```json
{
  "alt": "dk",
  "url": "/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png",
  "is_image": true,
  "markdown": "![dk](/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png)"
}
```

**Note**: The returned `url` is relative to the project path.
In Markdown contexts, the link is automatically expanded when the format in `markdown` is used.


826 827 828
## Team members

### List project team members
829

830
Get a list of a project's team members.
831 832

```
833
GET /projects/:id/members
834 835 836 837
```

Parameters:

838 839
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `query` (optional) - Query string to search for members
840 841

### Get project team member
842

843
Gets a project team member.
844

845 846 847 848 849
```
GET /projects/:id/members/:user_id
```

Parameters:
850

851 852
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `user_id` (required) - The ID of a user
853 854 855 856

```json
{
  "id": 1,
857
  "username": "john_smith",
858 859
  "email": "john@example.com",
  "name": "John Smith",
860
  "state": "active",
861 862 863
  "created_at": "2012-05-23T08:00:58Z",
  "access_level": 40
}
864
```
865

866
### Add project team member
867

868 869
Adds a user to a project team. This is an idempotent method and can be called multiple times
with the same parameters. Adding team membership to a user that is already a member does not
870
affect the existing membership.
871 872 873

```
POST /projects/:id/members
874 875 876 877
```

Parameters:

878 879 880
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `user_id` (required) - The ID of a user to add
- `access_level` (required) - Project access level
881 882

### Edit project team member
883

884
Updates a project team member to a specified access level.
885 886

```
887
PUT /projects/:id/members/:user_id
888 889 890 891
```

Parameters:

892 893 894
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `user_id` (required) - The ID of a team member
- `access_level` (required) - Project access level
895 896

### Remove project team member
897

898
Removes a user from a project team.
899 900

```
901
DELETE /projects/:id/members/:user_id
902 903 904 905
```

Parameters:

906 907
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `user_id` (required) - The ID of a team member
908

909 910 911 912
This method removes the project member if the user has the proper access rights to do so.
It returns a status code 403 if the member does not have the proper rights to perform this action.
In all other cases this method is idempotent and revoking team membership for a user who is not
currently a team member is considered success.
913
Please note that the returned JSON currently differs slightly. Thus you should not
914
rely on the returned JSON structure.
915

916 917 918 919 920 921 922 923 924 925 926 927 928 929
### Share project with group

Allow to share project with group.

```
POST /projects/:id/share
```

Parameters:

- `id` (required) - The ID of a project
- `group_id` (required) - The ID of a group
- `group_access` (required) - Level of permissions for sharing

930 931
## Hooks

932 933 934
Also called Project Hooks and Webhooks.
These are different for [System Hooks](system_hooks.md) that are system wide.

935 936
### List project hooks

937
Get a list of project hooks.
miks committed
938 939 940 941 942 943 944

```
GET /projects/:id/hooks
```

Parameters:

945
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
miks committed
946

947
### Get project hook
948

949
Get a specific hook for a project.
950 951 952 953 954

```
GET /projects/:id/hooks/:hook_id
```

955
Parameters:
956

957 958
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `hook_id` (required) - The ID of a project hook
959

960 961 962 963
```json
{
  "id": 1,
  "url": "http://example.com/hook",
964 965 966 967
  "project_id": 3,
  "push_events": "true",
  "issues_events": "true",
  "merge_requests_events": "true",
968 969
  "note_events": "true",
  "enable_ssl_verification": "true",
970 971 972 973 974 975
  "created_at": "2012-10-12T17:04:47Z"
}
```

### Add project hook

976
Adds a hook to a specified project.
miks committed
977 978 979 980 981 982 983

```
POST /projects/:id/hooks
```

Parameters:

984 985 986 987 988
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `url` (required) - The hook URL
- `push_events` - Trigger hook on push events
- `issues_events` - Trigger hook on issues events
- `merge_requests_events` - Trigger hook on merge_requests events
989
- `tag_push_events` - Trigger hook on push_tag events
990
- `note_events` - Trigger hook on note events
991
- `enable_ssl_verification` - Do SSL verification when triggering the hook
992

993 994
### Edit project hook

995
Edits a hook for a specified project.
996 997 998 999 1000 1001 1002

```
PUT /projects/:id/hooks/:hook_id
```

Parameters:

1003 1004 1005 1006 1007 1008
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `hook_id` (required) - The ID of a project hook
- `url` (required) - The hook URL
- `push_events` - Trigger hook on push events
- `issues_events` - Trigger hook on issues events
- `merge_requests_events` - Trigger hook on merge_requests events
1009
- `tag_push_events` - Trigger hook on push_tag events
1010
- `note_events` - Trigger hook on note events
1011
- `enable_ssl_verification` - Do SSL verification when triggering the hook
1012

1013
### Delete project hook
miks committed
1014

1015
Removes a hook from a project. This is an idempotent method and can be called multiple times.
1016
Either the hook is available or not.
miks committed
1017 1018

```
1019
DELETE /projects/:id/hooks/:hook_id
miks committed
1020 1021 1022 1023
```

Parameters:

1024 1025
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `hook_id` (required) - The ID of hook to delete
miks committed
1026

1027 1028
Note the JSON response differs if the hook is available or not. If the project hook
is available before it is returned in the JSON response or an empty response is returned.
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041

## Branches

### List branches

Lists all branches of a project.

```
GET /projects/:id/repository/branches
```

Parameters:

1042
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
1043

1044 1045 1046
```json
[
  {
1047
    "name": "async",
1048
    "commit": {
1049 1050 1051 1052 1053 1054
      "id": "a2b702edecdf41f07b42653eb1abe30ce98b9fca",
      "parents": [
        {
          "id": "3f94fc7c85061973edc9906ae170cc269b07ca55"
        }
      ],
1055
      "tree": "c68537c6534a02cc2b176ca1549f4ffa190b58ee",
1056
      "message": "give Caolan credit where it's due (up top)",
1057
      "author": {
1058 1059
        "name": "Jeremy Ashkenas",
        "email": "jashkenas@example.com"
1060 1061
      },
      "committer": {
1062 1063
        "name": "Jeremy Ashkenas",
        "email": "jashkenas@example.com"
1064
      },
1065 1066
      "authored_date": "2010-12-08T21:28:50+00:00",
      "committed_date": "2010-12-08T21:28:50+00:00"
1067
    },
1068
    "protected": false
1069 1070 1071 1072 1073
  },
  {
    "name": "gh-pages",
    "commit": {
      "id": "101c10a60019fe870d21868835f65c25d64968fc",
1074 1075 1076 1077 1078
      "parents": [
        {
          "id": "9c15d2e26945a665131af5d7b6d30a06ba338aaa"
        }
      ],
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
      "tree": "fb5cc9d45da3014b17a876ad539976a0fb9b352a",
      "message": "Underscore.js 1.5.2",
      "author": {
        "name": "Jeremy Ashkenas",
        "email": "jashkenas@example.com"
      },
      "committer": {
        "name": "Jeremy Ashkenas",
        "email": "jashkenas@example.com"
      },
      "authored_date": "2013-09-07T12: 58: 21+00: 00",
      "committed_date": "2013-09-07T12: 58: 21+00: 00"
    },
    "protected": false
  }
]
```
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106

### List single branch

Lists a specific branch of a project.

```
GET /projects/:id/repository/branches/:branch
```

Parameters:

1107 1108
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `branch` (required) - The name of the branch.
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119

### Protect single branch

Protects a single branch of a project.

```
PUT /projects/:id/repository/branches/:branch/protect
```

Parameters:

1120 1121
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `branch` (required) - The name of the branch.
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132

### Unprotect single branch

Unprotects a single branch of a project.

```
PUT /projects/:id/repository/branches/:branch/unprotect
```

Parameters:

1133 1134
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `branch` (required) - The name of the branch.
1135 1136 1137

## Admin fork relation

1138
Allows modification of the forked relationship between existing projects. Available only for admins.
1139 1140 1141 1142 1143 1144 1145 1146 1147

### Create a forked from/to relation between existing projects.

```
POST /projects/:id/fork/:forked_from_id
```

Parameters:

1148 1149
- `id` (required) - The ID of the project
- `forked_from_id:` (required) - The ID of the project that was forked from
1150 1151 1152 1153 1154 1155 1156 1157 1158

### Delete an existing forked from relationship

```
DELETE /projects/:id/fork
```

Parameter:

1159
- `id` (required) - The ID of the project
1160 1161 1162

## Search for projects by name

1163
Search for projects by name which are accessible to the authenticated user.
1164 1165 1166 1167 1168 1169 1170

```
GET /projects/search/:query
```

Parameters:

1171 1172 1173 1174 1175
- `query` (required) - A string contained in the project name
- `per_page` (optional) - number of projects to return per page
- `page` (optional) - the page to retrieve
- `order_by` (optional) - Return requests ordered by `id`, `name`, `created_at` or `last_activity_at` fields
- `sort` (optional) - Return requests sorted in `asc` or `desc` order