BigW Consortium Gitlab

projects.md 40.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 for which the authenticated user is a member.
24 25 26 27 28

```
GET /projects
```

29 30
Parameters:

31 32 33 34 35 36 37 38
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `archived` | boolean | no | Limit by archived status |
| `visibility` | string | no | Limit by visibility `public`, `internal`, or `private` |
| `order_by` | string | no | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at` |
| `sort` | string | no | Return projects sorted in `asc` or `desc` order. Default is `desc` |
| `search` | string | no | Return list of authorized projects matching the search criteria |
| `simple` | boolean | no | Return only the ID, URL, name, and path of each project |
39

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

159
Get a list of projects which the authenticated user can see.
160 161 162 163 164 165 166

```
GET /projects/visible
```

Parameters:

167 168 169 170 171 172 173 174
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `archived` | boolean | no | Limit by archived status |
| `visibility` | string | no | Limit by visibility `public`, `internal`, or `private` |
| `order_by` | string | no | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at` |
| `sort` | string | no | Return projects sorted in `asc` or `desc` order. Default is `desc` |
| `search` | string | no | Return list of authorized projects matching the search criteria |
| `simple` | boolean | no | Return only the ID, URL, name, and path of each project |
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 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 277 278 279 280 281 282 283 284 285 286 287 288 289 290

```json
[
  {
    "id": 4,
    "description": null,
    "default_branch": "master",
    "public": false,
    "visibility_level": 0,
    "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",
    "tag_list": [
      "example",
      "disapora client"
    ],
    "owner": {
      "id": 3,
      "name": "Diaspora",
      "created_at": "2013-09-30T13:46:02Z"
    },
    "name": "Diaspora Client",
    "name_with_namespace": "Diaspora / Diaspora Client",
    "path": "diaspora-client",
    "path_with_namespace": "diaspora/diaspora-client",
    "issues_enabled": true,
    "open_issues_count": 1,
    "merge_requests_enabled": true,
    "builds_enabled": true,
    "wiki_enabled": true,
    "snippets_enabled": false,
    "container_registry_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": false,
    "avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png",
    "shared_runners_enabled": true,
    "forks_count": 0,
    "star_count": 0,
    "runners_token": "b8547b1dc37721d05889db52fa2f02",
    "public_builds": true,
    "shared_with_groups": []
  },
  {
    "id": 6,
    "description": null,
    "default_branch": "master",
    "public": false,
    "visibility_level": 0,
    "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",
    "tag_list": [
      "example",
      "puppet"
    ],
    "owner": {
      "id": 4,
      "name": "Brightbox",
      "created_at": "2013-09-30T13:46:02Z"
    },
    "name": "Puppet",
    "name_with_namespace": "Brightbox / Puppet",
    "path": "puppet",
    "path_with_namespace": "brightbox/puppet",
    "issues_enabled": true,
    "open_issues_count": 1,
    "merge_requests_enabled": true,
    "builds_enabled": true,
    "wiki_enabled": true,
    "snippets_enabled": false,
    "container_registry_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": 4,
      "name": "Brightbox",
      "owner_id": 1,
      "path": "brightbox",
      "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": null,
    "shared_runners_enabled": true,
    "forks_count": 0,
    "star_count": 0,
    "runners_token": "b8547b1dc37721d05889db52fa2f02",
    "public_builds": true,
    "shared_with_groups": []
  }
]
```

291
### List owned projects
292

293
Get a list of projects which are owned by the authenticated user.
294 295 296 297 298

```
GET /projects/owned
```

299 300
Parameters:

301 302 303 304 305 306 307
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `archived` | boolean | no | Limit by archived status |
| `visibility` | string | no | Limit by visibility `public`, `internal`, or `private` |
| `order_by` | string | no | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at` |
| `sort` | string | no | Return projects sorted in `asc` or `desc` order. Default is `desc` |
| `search` | string | no | Return list of authorized projects matching the search criteria |
308 309 310 311 312 313 314 315 316 317 318

### List starred projects

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

```
GET /projects/starred
```

Parameters:

319 320 321 322 323 324 325
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `archived` | boolean | no | Limit by archived status |
| `visibility` | string | no | Limit by visibility `public`, `internal`, or `private` |
| `order_by` | string | no | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at` |
| `sort` | string | no | Return projects sorted in `asc` or `desc` order. Default is `desc` |
| `search` | string | no | Return list of authorized projects matching the search criteria |
326

327
### List ALL projects
328 329 330 331 332 333 334

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

```
GET /projects/all
```

335 336
Parameters:

337 338 339 340 341 342 343
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `archived` | boolean | no | Limit by archived status |
| `visibility` | string | no | Limit by visibility `public`, `internal`, or `private` |
| `order_by` | string | no | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at` |
| `sort` | string | no | Return projects sorted in `asc` or `desc` order. Default is `desc` |
| `search` | string | no | Return list of authorized projects matching the search criteria |
344

345
### Get single project
346

347
Get a specific project, identified by project ID or NAMESPACE/PROJECT_NAME, which is owned by the authenticated user.
Marin Jankovski committed
348
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`).
349 350 351 352 353 354 355

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

Parameters:

356 357 358
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or NAMESPACE/PROJECT_NAME of the project |
359

360 361
```json
{
362
  "id": 3,
363
  "description": null,
364 365
  "default_branch": "master",
  "public": false,
366
  "visibility_level": 0,
367 368 369
  "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",
370 371 372 373
  "tag_list": [
    "example",
    "disapora project"
  ],
374
  "owner": {
375 376
    "id": 3,
    "name": "Diaspora",
Ben Boeckel committed
377
    "created_at": "2013-09-30T13:46:02Z"
378
  },
379 380 381 382
  "name": "Diaspora Project Site",
  "name_with_namespace": "Diaspora / Diaspora Project Site",
  "path": "diaspora-project-site",
  "path_with_namespace": "diaspora/diaspora-project-site",
383
  "issues_enabled": true,
384
  "open_issues_count": 1,
385
  "merge_requests_enabled": true,
386
  "builds_enabled": true,
387
  "wiki_enabled": true,
388
  "snippets_enabled": false,
389
  "container_registry_enabled": false,
Ben Boeckel committed
390 391
  "created_at": "2013-09-30T13:46:02Z",
  "last_activity_at": "2013-09-30T13:46:02Z",
392
  "creator_id": 3,
393
  "namespace": {
Ben Boeckel committed
394
    "created_at": "2013-09-30T13:46:02Z",
395 396 397 398 399
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
Ben Boeckel committed
400
    "updated_at": "2013-09-30T13:46:02Z"
401
  },
Dmitriy Zaporozhets committed
402 403 404 405 406 407 408 409 410
  "permissions": {
    "project_access": {
      "access_level": 10,
      "notification_level": 3
    },
    "group_access": {
      "access_level": 50,
      "notification_level": 3
    }
411
  },
412
  "archived": false,
Tomasz Maczukin committed
413 414 415 416
  "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
  "shared_runners_enabled": true,
  "forks_count": 0,
  "star_count": 0,
417 418 419 420 421 422 423 424 425 426 427 428 429
  "runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
  "public_builds": true,
  "shared_with_groups": [
    {
      "group_id": 4,
      "group_name": "Twitter",
      "group_access_level": 30
    },
    {
      "group_id": 3,
      "group_name": "Gitlab Org",
      "group_access_level": 10
    }
430
  ],
431 432
  "only_allow_merge_if_build_succeeds": false,
  "request_access_enabled": false
433 434 435
}
```

436 437
### Get project events

438
Get the events for the specified project.
439
Sorted from newest to oldest
440 441 442 443 444 445 446

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

Parameters:

447 448 449
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or NAMESPACE/PROJECT_NAME of the project |
450 451

```json
452 453 454 455 456 457 458 459 460
[
  {
    "title": null,
    "project_id": 15,
    "action_name": "closed",
    "target_id": 830,
    "target_type": "Issue",
    "author_id": 1,
    "data": null,
461 462 463 464 465 466 467 468 469 470
    "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"
471 472 473 474 475 476 477 478
  },
  {
    "title": null,
    "project_id": 15,
    "action_name": "opened",
    "target_id": null,
    "target_type": null,
    "author_id": 1,
479 480 481 482 483 484 485 486
    "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"
    },
487
    "author_username": "john",
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
    "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
513
    },
514
    "target_title": null
515
  },
516 517 518 519 520 521 522 523
  {
    "title": null,
    "project_id": 15,
    "action_name": "closed",
    "target_id": 840,
    "target_type": "Issue",
    "author_id": 1,
    "data": null,
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 559 560 561 562 563 564 565 566 567 568 569 570 571 572
    "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"
573 574
  }
]
575 576
```

577
### Create project
578

579
Creates a new project owned by the authenticated user.
580 581 582 583 584 585 586

```
POST /projects
```

Parameters:

587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `name` | string | yes | The name of the new project |
| `path` | string | no | Custom repository name for new project. By default generated based on name |
| `namespace_id` | integer | no | Namespace for the new project (defaults to the current user's namespace) |
| `description` | string | no | Short project description |
| `issues_enabled` | boolean | no | Enable issues for this project |
| `merge_requests_enabled` | boolean | no | Enable merge requests for this project |
| `builds_enabled` | boolean | no | Enable builds for this project |
| `wiki_enabled` | boolean | no | Enable wiki for this project |
| `snippets_enabled` | boolean | no | Enable snippets for this project |
| `container_registry_enabled` | boolean | no | Enable container registry for this project |
| `shared_runners_enabled` | boolean | no | Enable shared runners for this project |
| `public` | boolean | no | If `true`, the same as setting `visibility_level` to 20 |
| `visibility_level` | integer | no | See [project visibility level][#project-visibility-level] |
| `import_url` | string | no | URL to import repository from |
| `public_builds` | boolean | no | If `true`, builds can be viewed by non-project-members |
| `only_allow_merge_if_build_succeeds` | boolean | no | Set whether merge requests can only be merged with successful builds |
| `lfs_enabled` | boolean | no | Enable LFS |
| `request_access_enabled` | boolean | no | Allow users to request member access |
607

608 609
### Create project for user

610
Creates a new project owned by the specified user. Available only for admins.
611 612 613 614 615 616 617

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

Parameters:

618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `user_id` | integer | yes | The user ID of the project owner |
| `name` | string | yes | The name of the new project |
| `path` | string | no | Custom repository name for new project. By default generated based on name |
| `namespace_id` | integer | no | Namespace for the new project (defaults to the current user's namespace) |
| `description` | string | no | Short project description |
| `issues_enabled` | boolean | no | Enable issues for this project |
| `merge_requests_enabled` | boolean | no | Enable merge requests for this project |
| `builds_enabled` | boolean | no | Enable builds for this project |
| `wiki_enabled` | boolean | no | Enable wiki for this project |
| `snippets_enabled` | boolean | no | Enable snippets for this project |
| `container_registry_enabled` | boolean | no | Enable container registry for this project |
| `shared_runners_enabled` | boolean | no | Enable shared runners for this project |
| `public` | boolean | no | If `true`, the same as setting `visibility_level` to 20 |
| `visibility_level` | integer | no | See [project visibility level][#project-visibility-level] |
| `import_url` | string | no | URL to import repository from |
| `public_builds` | boolean | no | If `true`, builds can be viewed by non-project-members |
| `only_allow_merge_if_build_succeeds` | boolean | no | Set whether merge requests can only be merged with successful builds |
| `lfs_enabled` | boolean | no | Enable LFS |
| `request_access_enabled` | boolean | no | Allow users to request member access |
639

640 641 642 643 644 645 646 647 648 649
### Edit project

Updates an existing project

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

Parameters:

650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or NAMESPACE/PROJECT_NAME of the project |
| `name` | string | yes | The name of the project |
| `path` | string | no | Custom repository name for the project. By default generated based on name |
| `description` | string | no | Short project description |
| `issues_enabled` | boolean | no | Enable issues for this project |
| `merge_requests_enabled` | boolean | no | Enable merge requests for this project |
| `builds_enabled` | boolean | no | Enable builds for this project |
| `wiki_enabled` | boolean | no | Enable wiki for this project |
| `snippets_enabled` | boolean | no | Enable snippets for this project |
| `container_registry_enabled` | boolean | no | Enable container registry for this project |
| `shared_runners_enabled` | boolean | no | Enable shared runners for this project |
| `public` | boolean | no | If `true`, the same as setting `visibility_level` to 20 |
| `visibility_level` | integer | no | See [project visibility level][#project-visibility-level] |
| `import_url` | string | no | URL to import repository from |
| `public_builds` | boolean | no | If `true`, builds can be viewed by non-project-members |
| `only_allow_merge_if_build_succeeds` | boolean | no | Set whether merge requests can only be merged with successful builds |
| `lfs_enabled` | boolean | no | Enable LFS |
| `request_access_enabled` | boolean | no | Allow users to request member access |
670

671
On success, method returns 200 with the updated project. If parameters are
672 673
invalid, 400 is returned.

674 675
### Fork project

676
Forks a project into the user namespace of the authenticated user or the one provided.
677 678 679 680 681 682 683

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

Parameters:

684 685 686 687
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or NAMESPACE/PROJECT_NAME of the project |
| `namespace` | integer/string | yes | The ID or path of the namespace that the project will be forked to |
688

689 690
### Star a project

691 692
Stars a given project. Returns status code `201` and the project on success and
`304` if the project is already starred.
693 694 695 696 697

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

698 699
Parameters:

700 701
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
702
| `id` | integer/string | yes | The ID or NAMESPACE/PROJECT_NAME of the project |
703 704

```bash
705
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/star"
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
```

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,
734
  "container_registry_enabled": false,
Ben Boeckel committed
735 736
  "created_at": "2013-09-30T13:46:02Z",
  "last_activity_at": "2013-09-30T13:46:02Z",
737 738
  "creator_id": 3,
  "namespace": {
Ben Boeckel committed
739
    "created_at": "2013-09-30T13:46:02Z",
740 741 742 743 744
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
Ben Boeckel committed
745
    "updated_at": "2013-09-30T13:46:02Z"
746 747 748 749 750
  },
  "archived": true,
  "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
  "shared_runners_enabled": true,
  "forks_count": 0,
751 752
  "star_count": 1,
  "public_builds": true,
753
  "shared_with_groups": [],
754 755
  "only_allow_merge_if_build_succeeds": false,
  "request_access_enabled": false
756 757 758 759 760
}
```

### Unstar a project

761 762
Unstars a given project. Returns status code `200` and the project on success
and `304` if the project is not starred.
763 764

```
765
DELETE /projects/:id/star
766 767 768 769
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
770
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
771 772

```bash
773
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/star"
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
```

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,
802
  "container_registry_enabled": false,
Ben Boeckel committed
803 804
  "created_at": "2013-09-30T13:46:02Z",
  "last_activity_at": "2013-09-30T13:46:02Z",
805 806
  "creator_id": 3,
  "namespace": {
Ben Boeckel committed
807
    "created_at": "2013-09-30T13:46:02Z",
808 809 810 811 812
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
Ben Boeckel committed
813
    "updated_at": "2013-09-30T13:46:02Z"
814 815 816 817 818
  },
  "archived": true,
  "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
  "shared_runners_enabled": true,
  "forks_count": 0,
819 820
  "star_count": 0,
  "public_builds": true,
821
  "shared_with_groups": [],
822 823
  "only_allow_merge_if_build_succeeds": false,
  "request_access_enabled": false
824 825 826
}
```

827 828
### Archive a project

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

832 833 834
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.
835 836

```
837
POST /projects/:id/archive
838 839 840 841
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
842
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
843 844

```bash
845
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/archive"
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
```

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",
Ben Boeckel committed
867
    "created_at": "2013-09-30T13:46:02Z"
868 869 870 871 872 873 874 875 876 877 878
  },
  "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,
879
  "container_registry_enabled": false,
Ben Boeckel committed
880 881
  "created_at": "2013-09-30T13:46:02Z",
  "last_activity_at": "2013-09-30T13:46:02Z",
882 883
  "creator_id": 3,
  "namespace": {
Ben Boeckel committed
884
    "created_at": "2013-09-30T13:46:02Z",
885 886 887 888 889
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
Ben Boeckel committed
890
    "updated_at": "2013-09-30T13:46:02Z"
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
  },
  "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,
907 908
  "runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
  "public_builds": true,
909
  "shared_with_groups": [],
910 911
  "only_allow_merge_if_build_succeeds": false,
  "request_access_enabled": false
912 913 914 915 916
}
```

### Unarchive a project

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

920 921 922
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.
923 924

```
Sergey Gnuskov committed
925
POST /projects/:id/unarchive
926 927 928 929
```

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
930
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
931 932

```bash
933
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/unarchive"
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
```

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",
Ben Boeckel committed
955
    "created_at": "2013-09-30T13:46:02Z"
956 957 958 959 960 961 962 963 964 965 966
  },
  "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,
967
  "container_registry_enabled": false,
Ben Boeckel committed
968 969
  "created_at": "2013-09-30T13:46:02Z",
  "last_activity_at": "2013-09-30T13:46:02Z",
970 971
  "creator_id": 3,
  "namespace": {
Ben Boeckel committed
972
    "created_at": "2013-09-30T13:46:02Z",
973 974 975 976 977
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
Ben Boeckel committed
978
    "updated_at": "2013-09-30T13:46:02Z"
979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994
  },
  "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,
995 996
  "runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
  "public_builds": true,
997
  "shared_with_groups": [],
998 999
  "only_allow_merge_if_build_succeeds": false,
  "request_access_enabled": false
1000 1001 1002
}
```

1003
### Remove project
1004

1005
Removes a project including all associated resources (issues, merge requests etc.)
1006 1007 1008 1009 1010 1011 1012

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

Parameters:

1013 1014 1015
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
1016

1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
## 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:

1029 1030 1031 1032
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
| `file` | string | yes | The file to be uploaded |
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045

```json
{
  "alt": "dk",
  "url": "/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png",
  "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.


1046
## Project members
1047

1048
Please consult the [Project Members](members.md) documentation.
1049

1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
### Share project with group

Allow to share project with group.

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

Parameters:

1060 1061 1062 1063 1064 1065
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
| `group_id` | integer | yes | The ID of the group to share with |
| `group_access` | integer | yes | The permissions level to grant the group |
| `expires_at` | string | no | Share expiration date in ISO 8601 format: 2016-09-26 |
1066

1067 1068
## Hooks

1069 1070 1071
Also called Project Hooks and Webhooks.
These are different for [System Hooks](system_hooks.md) that are system wide.

1072 1073
### List project hooks

1074
Get a list of project hooks.
miks committed
1075 1076 1077 1078 1079 1080 1081

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

Parameters:

1082 1083 1084
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
miks committed
1085

1086
### Get project hook
1087

1088
Get a specific hook for a project.
1089 1090 1091 1092 1093

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

1094
Parameters:
1095

1096 1097 1098 1099
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
| `hook_id` | integer | yes | The ID of a project hook |
1100

1101 1102 1103 1104
```json
{
  "id": 1,
  "url": "http://example.com/hook",
1105
  "project_id": 3,
Ben Boeckel committed
1106 1107 1108
  "push_events": true,
  "issues_events": true,
  "merge_requests_events": true,
1109
  "tag_push_events": true,
Ben Boeckel committed
1110
  "note_events": true,
1111 1112
  "build_events": true,
  "pipeline_events": true,
1113
  "wiki_page_events": true,
Ben Boeckel committed
1114
  "enable_ssl_verification": true,
1115 1116 1117 1118 1119 1120
  "created_at": "2012-10-12T17:04:47Z"
}
```

### Add project hook

1121
Adds a hook to a specified project.
miks committed
1122 1123 1124 1125 1126 1127 1128

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

Parameters:

1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
| `url` | string | yes | The hook URL |
| `push_events` | boolean | no | Trigger hook on push events |
| `issues_events` | boolean | no | Trigger hook on issues events |
| `merge_requests_events` | boolean | no | Trigger hook on merge requests events |
| `tag_push_events` | boolean | no | Trigger hook on tag push events |
| `note_events` | boolean | no | Trigger hook on note events |
| `build_events` | boolean | no | Trigger hook on build events |
| `pipeline_events` | boolean | no | Trigger hook on pipeline events |
| `wiki_events` | boolean | no | Trigger hook on wiki events |
| `enable_ssl_verification` | boolean | no | Do SSL verification when triggering the hook |
1142

1143 1144
### Edit project hook

1145
Edits a hook for a specified project.
1146 1147 1148 1149 1150 1151 1152

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

Parameters:

1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
| `hook_id` | integer | yes | The ID of the project hook |
| `url` | string | yes | The hook URL |
| `push_events` | boolean | no | Trigger hook on push events |
| `issues_events` | boolean | no | Trigger hook on issues events |
| `merge_requests_events` | boolean | no | Trigger hook on merge requests events |
| `tag_push_events` | boolean | no | Trigger hook on tag push events |
| `note_events` | boolean | no | Trigger hook on note events |
| `build_events` | boolean | no | Trigger hook on build events |
| `pipeline_events` | boolean | no | Trigger hook on pipeline events |
| `wiki_events` | boolean | no | Trigger hook on wiki events |
| `enable_ssl_verification` | boolean | no | Do SSL verification when triggering the hook |
1167

1168
### Delete project hook
miks committed
1169

1170
Removes a hook from a project. This is an idempotent method and can be called multiple times.
1171
Either the hook is available or not.
miks committed
1172 1173

```
1174
DELETE /projects/:id/hooks/:hook_id
miks committed
1175 1176 1177 1178
```

Parameters:

1179 1180 1181 1182
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
| `hook_id` | integer | yes | The ID of the project hook |
miks committed
1183

1184 1185
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.
1186 1187 1188

## Branches

Miroslav Meca committed
1189 1190
For more information please consult the [Branches](branches.md) documentation.

1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
### List branches

Lists all branches of a project.

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

Parameters:

1201 1202 1203
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
1204

1205 1206 1207
```json
[
  {
1208
    "name": "async",
1209
    "commit": {
1210
      "id": "a2b702edecdf41f07b42653eb1abe30ce98b9fca",
Miroslav Meca committed
1211 1212
      "parent_ids": [
        "3f94fc7c85061973edc9906ae170cc269b07ca55"
1213
      ],
1214
      "message": "give Caolan credit where it's due (up top)",
Miroslav Meca committed
1215 1216
      "author_name": "Jeremy Ashkenas",
      "author_email": "jashkenas@example.com",
1217
      "authored_date": "2010-12-08T21:28:50+00:00",
Miroslav Meca committed
1218 1219
      "committer_name": "Jeremy Ashkenas",
      "committer_email": "jashkenas@example.com",
1220
      "committed_date": "2010-12-08T21:28:50+00:00"
1221
    },
Miroslav Meca committed
1222 1223 1224
    "protected": false,
    "developers_can_push": false,
    "developers_can_merge": false
1225 1226 1227 1228 1229
  },
  {
    "name": "gh-pages",
    "commit": {
      "id": "101c10a60019fe870d21868835f65c25d64968fc",
Miroslav Meca committed
1230 1231
      "parent_ids": [
          "9c15d2e26945a665131af5d7b6d30a06ba338aaa"
1232
      ],
1233
      "message": "Underscore.js 1.5.2",
Miroslav Meca committed
1234 1235
      "author_name": "Jeremy Ashkenas",
      "author_email": "jashkenas@example.com",
Ben Boeckel committed
1236
      "authored_date": "2013-09-07T12:58:21+00:00",
Miroslav Meca committed
1237 1238
      "committer_name": "Jeremy Ashkenas",
      "committer_email": "jashkenas@example.com",
Ben Boeckel committed
1239
      "committed_date": "2013-09-07T12:58:21+00:00"
1240
    },
Miroslav Meca committed
1241 1242 1243
    "protected": false,
    "developers_can_push": false,
    "developers_can_merge": false
1244 1245 1246
  }
]
```
1247

Miroslav Meca committed
1248
### Single branch
1249

Miroslav Meca committed
1250
A specific branch of a project.
1251 1252 1253 1254 1255 1256 1257

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

Parameters:

1258 1259 1260 1261 1262 1263
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
| `branch` | string | yes | The name of the branch |
| `developers_can_push` | boolean | no | Flag if developers can push to the branch |
| `developers_can_merge` | boolean | no | Flag if developers can merge to the branch |
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274

### Protect single branch

Protects a single branch of a project.

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

Parameters:

1275 1276 1277 1278
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
| `branch` | string | yes | The name of the branch |
1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289

### Unprotect single branch

Unprotects a single branch of a project.

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

Parameters:

1290 1291 1292 1293
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
| `branch` | string | yes | The name of the branch |
1294 1295 1296

## Admin fork relation

1297
Allows modification of the forked relationship between existing projects. Available only for admins.
1298 1299 1300 1301 1302 1303 1304 1305 1306

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

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

Parameters:

1307 1308 1309 1310
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
| `forked_from_id` | ID | yes | The ID of the project that was forked from |
1311 1312 1313 1314 1315 1316 1317 1318 1319

### Delete an existing forked from relationship

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

Parameter:

1320 1321 1322
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
1323 1324 1325

## Search for projects by name

1326
Search for projects by name which are accessible to the authenticated user.
1327 1328 1329 1330 1331 1332 1333

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

Parameters:

1334 1335 1336 1337 1338 1339 1340
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `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` | string | no | Return requests sorted in `asc` or `desc` order |