projects.md 17.8 KB
Newer Older
Marin Jankovski's avatar
Marin Jankovski committed
1
# Projects
2

3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

### Project visibility level

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

Constants for project visibility levels are next:

* Private. `visibility_level` is `0`. 
  Project access must be granted explicitly for each user.

* Internal. `visibility_level` is `10`.
  The project can be cloned by any logged in user.
 
* Public. `visibility_level` is `20`.
  The project can be cloned without any authentication.


21
## List projects
Nihad Abbasov's avatar
Nihad Abbasov committed
22

23
Get a list of projects accessible by the authenticated user.
Nihad Abbasov's avatar
Nihad Abbasov committed
24 25 26 27 28

```
GET /projects
```

29 30
Parameters:

31
- `archived` (optional) - if passed, limit by archived status
32 33
- `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`
34
- `search` (optional) - Return list of authorized projects according to a search criteria
Valery Sizov's avatar
Valery Sizov committed
35
- `ci_enabled_first` - Return projects ordered by ci_enabled flag. Projects with enabled GitLab CI go first
36

Nihad Abbasov's avatar
Nihad Abbasov committed
37 38 39
```json
[
  {
Marin Jankovski's avatar
Marin Jankovski committed
40
    "id": 4,
Nihad Abbasov's avatar
Nihad Abbasov committed
41 42
    "description": null,
    "default_branch": "master",
Marin Jankovski's avatar
Marin Jankovski committed
43
    "public": false,
44
    "visibility_level": 0,
Marin Jankovski's avatar
Marin Jankovski committed
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"
    ],
Nihad Abbasov's avatar
Nihad Abbasov committed
52
    "owner": {
Marin Jankovski's avatar
Marin Jankovski committed
53 54 55
      "id": 3,
      "name": "Diaspora",
      "created_at": "2013-09-30T13: 46: 02Z"
Nihad Abbasov's avatar
Nihad Abbasov committed
56
    },
Marin Jankovski's avatar
Marin Jankovski committed
57 58 59 60 61 62
    "name": "Diaspora Client",
    "name_with_namespace": "Diaspora / Diaspora Client",
    "path": "diaspora-client",
    "path_with_namespace": "diaspora/diaspora-client",
    "issues_enabled": true,
    "merge_requests_enabled": true,
Nihad Abbasov's avatar
Nihad Abbasov committed
63
    "wiki_enabled": true,
Marin Jankovski's avatar
Marin Jankovski committed
64 65 66
    "snippets_enabled": false,
    "created_at": "2013-09-30T13: 46: 02Z",
    "last_activity_at": "2013-09-30T13: 46: 02Z",
67
    "creator_id": 3,
Marin Jankovski's avatar
Marin Jankovski committed
68 69 70 71 72 73 74 75
    "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"
76
    },
sue445's avatar
sue445 committed
77 78
    "archived": false,
    "avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png"
Nihad Abbasov's avatar
Nihad Abbasov committed
79 80
  },
  {
Marin Jankovski's avatar
Marin Jankovski committed
81
    "id": 6,
Nihad Abbasov's avatar
Nihad Abbasov committed
82
    "description": null,
Marin Jankovski's avatar
Marin Jankovski committed
83 84
    "default_branch": "master",
    "public": false,
85
    "visibility_level": 0,
Marin Jankovski's avatar
Marin Jankovski committed
86 87 88
    "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",
89 90 91 92
    "tag_list": [
      "example",
      "puppet"
    ],
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
93
    "owner": {
Marin Jankovski's avatar
Marin Jankovski committed
94 95 96
      "id": 4,
      "name": "Brightbox",
      "created_at": "2013-09-30T13:46:02Z"
Nihad Abbasov's avatar
Nihad Abbasov committed
97
    },
Marin Jankovski's avatar
Marin Jankovski committed
98 99 100 101
    "name": "Puppet",
    "name_with_namespace": "Brightbox / Puppet",
    "path": "puppet",
    "path_with_namespace": "brightbox/puppet",
Nihad Abbasov's avatar
Nihad Abbasov committed
102 103 104
    "issues_enabled": true,
    "merge_requests_enabled": true,
    "wiki_enabled": true,
Marin Jankovski's avatar
Marin Jankovski committed
105 106 107
    "snippets_enabled": false,
    "created_at": "2013-09-30T13:46:02Z",
    "last_activity_at": "2013-09-30T13:46:02Z",
108
    "creator_id": 3,
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
109
    "namespace": {
Marin Jankovski's avatar
Marin Jankovski committed
110 111 112 113 114 115 116
      "created_at": "2013-09-30T13:46:02Z",
      "description": "",
      "id": 4,
      "name": "Brightbox",
      "owner_id": 1,
      "path": "brightbox",
      "updated_at": "2013-09-30T13:46:02Z"
117
    },
sue445's avatar
sue445 committed
118 119
    "archived": false,
    "avatar_url": null
Nihad Abbasov's avatar
Nihad Abbasov committed
120 121 122 123
  }
]
```

124
### List owned projects
125

126
Get a list of projects which are owned by the authenticated user.
127 128 129 130 131

```
GET /projects/owned
```

132 133 134 135 136 137
Parameters:

- `archived` (optional) - if passed, limit by archived status
- `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
Valery Sizov's avatar
Valery Sizov committed
138
- `ci_enabled_first` - Return projects ordered by ci_enabled flag. Projects with enabled GitLab CI go first
139

140
### List ALL projects
141 142 143 144 145 146 147

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

```
GET /projects/all
```

148 149 150 151 152 153
Parameters:

- `archived` (optional) - if passed, limit by archived status
- `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
Valery Sizov's avatar
Valery Sizov committed
154
- `ci_enabled_first` - Return projects ordered by ci_enabled flag. Projects with enabled GitLab CI go first
155

156
### Get single project
Nihad Abbasov's avatar
Nihad Abbasov committed
157

158
Get a specific project, identified by project ID or NAMESPACE/PROJECT_NAME, which is owned by the authenticated user.
Marin Jankovski's avatar
Marin Jankovski committed
159
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`).
Nihad Abbasov's avatar
Nihad Abbasov committed
160 161 162 163 164 165 166

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

Parameters:

167
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
Nihad Abbasov's avatar
Nihad Abbasov committed
168

169 170
```json
{
Marin Jankovski's avatar
Marin Jankovski committed
171
  "id": 3,
172
  "description": null,
Marin Jankovski's avatar
Marin Jankovski committed
173 174
  "default_branch": "master",
  "public": false,
175
  "visibility_level": 0,
Marin Jankovski's avatar
Marin Jankovski committed
176 177 178
  "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",
179 180 181 182
  "tag_list": [
    "example",
    "disapora project"
  ],
183
  "owner": {
Marin Jankovski's avatar
Marin Jankovski committed
184 185 186
    "id": 3,
    "name": "Diaspora",
    "created_at": "2013-09-30T13: 46: 02Z"
187
  },
Marin Jankovski's avatar
Marin Jankovski committed
188 189 190 191
  "name": "Diaspora Project Site",
  "name_with_namespace": "Diaspora / Diaspora Project Site",
  "path": "diaspora-project-site",
  "path_with_namespace": "diaspora/diaspora-project-site",
192 193 194
  "issues_enabled": true,
  "merge_requests_enabled": true,
  "wiki_enabled": true,
Marin Jankovski's avatar
Marin Jankovski committed
195 196 197
  "snippets_enabled": false,
  "created_at": "2013-09-30T13: 46: 02Z",
  "last_activity_at": "2013-09-30T13: 46: 02Z",
198
  "creator_id": 3,
Marin Jankovski's avatar
Marin Jankovski committed
199 200 201 202 203 204 205 206
  "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"
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
207
  },
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
208 209 210 211 212 213 214 215 216
  "permissions": {
    "project_access": {
      "access_level": 10,
      "notification_level": 3
    },
    "group_access": {
      "access_level": 50,
      "notification_level": 3
    }
217
  },
sue445's avatar
sue445 committed
218 219
  "archived": false,
  "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png"
220 221 222
}
```

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
223 224
### Get project events

225
Get the events for the specified project.
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
226 227 228 229 230 231 232 233
Sorted from newest to latest

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

Parameters:

234
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
235 236

```json
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
237 238 239 240 241 242 243 244
[
  {
    "title": null,
    "project_id": 15,
    "action_name": "closed",
    "target_id": 830,
    "target_type": "Issue",
    "author_id": 1,
245
    "author_username": "john",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
246 247 248 249 250 251 252 253 254 255
    "data": null,
    "target_title": "Public project search field"
  },
  {
    "title": null,
    "project_id": 15,
    "action_name": "opened",
    "target_id": null,
    "target_type": null,
    "author_id": 1,
256
    "author_username": "john",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
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
    "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
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
282
    },
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
283
    "target_title": null
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
284
  },
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
285 286 287 288 289 290 291
  {
    "title": null,
    "project_id": 15,
    "action_name": "closed",
    "target_id": 840,
    "target_type": "Issue",
    "author_id": 1,
292
    "author_username": "john",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
293 294 295 296
    "data": null,
    "target_title": "Finish & merge Code search PR"
  }
]
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
297 298
```

299
### Create project
300

301
Creates a new project owned by the authenticated user.
302 303 304 305 306 307 308

```
POST /projects
```

Parameters:

309
- `name` (required) - new project name
310
- `path` (optional) - custom repository name for new project. By default generated based on name
311 312 313 314 315 316 317 318 319
- `namespace_id` (optional) - namespace for the new project (defaults to user)
- `description` (optional) - short project description
- `issues_enabled` (optional)
- `merge_requests_enabled` (optional)
- `wiki_enabled` (optional)
- `snippets_enabled` (optional)
- `public` (optional) - if `true` same as setting visibility_level = 20
- `visibility_level` (optional)
- `import_url` (optional)
320

321 322
### Create project for user

323
Creates a new project owned by the specified user. Available only for admins.
324 325 326 327 328 329 330

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

Parameters:

331 332 333 334 335 336 337 338 339 340 341
- `user_id` (required) - user_id of owner
- `name` (required) - new project name
- `description` (optional) - short project description
- `default_branch` (optional) - 'master' by default
- `issues_enabled` (optional)
- `merge_requests_enabled` (optional)
- `wiki_enabled` (optional)
- `snippets_enabled` (optional)
- `public` (optional) - if `true` same as setting visibility_level = 20
- `visibility_level` (optional)
- `import_url` (optional)
342

343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
### 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)
- `wiki_enabled` (optional)
- `snippets_enabled` (optional)
- `public` (optional) - if `true` same as setting visibility_level = 20
- `visibility_level` (optional)

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

368 369 370 371 372 373 374 375 376 377 378 379
### 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

380
### Remove project
381

382
Removes a project including all associated resources (issues, merge requests etc.)
383 384 385 386 387 388 389

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

Parameters:

390
- `id` (required) - The ID of a project
391 392 393 394

## Team members

### List project team members
miks's avatar
miks committed
395

396
Get a list of a project's team members.
miks's avatar
miks committed
397 398

```
399
GET /projects/:id/members
miks's avatar
miks committed
400 401 402 403
```

Parameters:

404 405
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `query` (optional) - Query string to search for members
406 407

### Get project team member
miks's avatar
miks committed
408

409
Gets a project team member.
410

411 412 413 414 415
```
GET /projects/:id/members/:user_id
```

Parameters:
416

417 418
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `user_id` (required) - The ID of a user
419 420 421 422

```json
{
  "id": 1,
423
  "username": "john_smith",
424 425
  "email": "john@example.com",
  "name": "John Smith",
Marin Jankovski's avatar
Marin Jankovski committed
426
  "state": "active",
427 428 429
  "created_at": "2012-05-23T08:00:58Z",
  "access_level": 40
}
430
```
431

432
### Add project team member
433

434 435
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
436
affect the existing membership.
437 438 439

```
POST /projects/:id/members
440 441 442 443
```

Parameters:

444 445 446
- `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
447 448

### Edit project team member
miks's avatar
miks committed
449

450
Updates a project team member to a specified access level.
miks's avatar
miks committed
451 452

```
453
PUT /projects/:id/members/:user_id
miks's avatar
miks committed
454 455 456 457
```

Parameters:

458 459 460
- `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
461 462

### Remove project team member
miks's avatar
miks committed
463

464
Removes a user from a project team.
miks's avatar
miks committed
465 466

```
467
DELETE /projects/:id/members/:user_id
miks's avatar
miks committed
468 469 470 471
```

Parameters:

472 473
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `user_id` (required) - The ID of a team member
miks's avatar
miks committed
474

475 476 477
This method is idempotent and can be called multiple times with the same parameters.
Revoking team membership for a user who is not currently a team member is considered success.
Please note that the returned JSON currently differs slightly. Thus you should not
478
rely on the returned JSON structure.
Nihad Abbasov's avatar
Nihad Abbasov committed
479

480 481 482 483
## Hooks

### List project hooks

484
Get a list of project hooks.
miks's avatar
miks committed
485 486 487 488 489 490 491

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

Parameters:

492
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
miks's avatar
miks committed
493

494
### Get project hook
495

496
Get a specific hook for a project.
497 498 499 500 501

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

502
Parameters:
503

504 505
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `hook_id` (required) - The ID of a project hook
506

507 508 509 510
```json
{
  "id": 1,
  "url": "http://example.com/hook",
511 512 513 514
  "project_id": 3,
  "push_events": "true",
  "issues_events": "true",
  "merge_requests_events": "true",
515 516 517 518 519 520
  "created_at": "2012-10-12T17:04:47Z"
}
```

### Add project hook

521
Adds a hook to a specified project.
miks's avatar
miks committed
522 523 524 525 526 527 528

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

Parameters:

529 530 531 532 533
- `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
534
- `tag_push_events` - Trigger hook on push_tag events
535

536 537
### Edit project hook

538
Edits a hook for a specified project.
539 540 541 542 543 544 545

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

Parameters:

546 547 548 549 550 551
- `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
552
- `tag_push_events` - Trigger hook on push_tag events
553

554
### Delete project hook
miks's avatar
miks committed
555

556
Removes a hook from a project. This is an idempotent method and can be called multiple times.
557
Either the hook is available or not.
miks's avatar
miks committed
558 559

```
560
DELETE /projects/:id/hooks/:hook_id
miks's avatar
miks committed
561 562 563 564
```

Parameters:

565 566
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `hook_id` (required) - The ID of hook to delete
miks's avatar
miks committed
567

568 569
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.
570 571 572 573 574 575 576 577 578 579 580 581 582

## Branches

### List branches

Lists all branches of a project.

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

Parameters:

583
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
584

Marin Jankovski's avatar
Marin Jankovski committed
585 586 587
```json
[
  {
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
588
    "name": "async",
Marin Jankovski's avatar
Marin Jankovski committed
589
    "commit": {
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
590 591 592 593 594 595
      "id": "a2b702edecdf41f07b42653eb1abe30ce98b9fca",
      "parents": [
        {
          "id": "3f94fc7c85061973edc9906ae170cc269b07ca55"
        }
      ],
Marin Jankovski's avatar
Marin Jankovski committed
596
      "tree": "c68537c6534a02cc2b176ca1549f4ffa190b58ee",
597
      "message": "give Caolan credit where it's due (up top)",
Marin Jankovski's avatar
Marin Jankovski committed
598
      "author": {
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
599 600
        "name": "Jeremy Ashkenas",
        "email": "jashkenas@example.com"
Marin Jankovski's avatar
Marin Jankovski committed
601 602
      },
      "committer": {
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
603 604
        "name": "Jeremy Ashkenas",
        "email": "jashkenas@example.com"
Marin Jankovski's avatar
Marin Jankovski committed
605
      },
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
606 607
      "authored_date": "2010-12-08T21:28:50+00:00",
      "committed_date": "2010-12-08T21:28:50+00:00"
Marin Jankovski's avatar
Marin Jankovski committed
608
    },
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
609
    "protected": false
Marin Jankovski's avatar
Marin Jankovski committed
610 611 612 613 614
  },
  {
    "name": "gh-pages",
    "commit": {
      "id": "101c10a60019fe870d21868835f65c25d64968fc",
Johannes Schleifenbaum's avatar
Johannes Schleifenbaum committed
615 616 617 618 619
      "parents": [
        {
          "id": "9c15d2e26945a665131af5d7b6d30a06ba338aaa"
        }
      ],
Marin Jankovski's avatar
Marin Jankovski committed
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
      "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
  }
]
```
637 638 639 640 641 642 643 644 645 646 647

### List single branch

Lists a specific branch of a project.

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

Parameters:

648 649
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `branch` (required) - The name of the branch.
650 651 652 653 654 655 656 657 658 659 660

### Protect single branch

Protects a single branch of a project.

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

Parameters:

661 662
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `branch` (required) - The name of the branch.
663 664 665 666 667 668 669 670 671 672 673

### Unprotect single branch

Unprotects a single branch of a project.

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

Parameters:

674 675
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `branch` (required) - The name of the branch.
676 677 678

## Admin fork relation

679
Allows modification of the forked relationship between existing projects. Available only for admins.
680 681 682 683 684 685 686 687 688

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

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

Parameters:

689 690
- `id` (required) - The ID of the project
- `forked_from_id:` (required) - The ID of the project that was forked from
691 692 693 694 695 696 697 698 699

### Delete an existing forked from relationship

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

Parameter:

700
- `id` (required) - The ID of the project
701 702 703

## Search for projects by name

704
Search for projects by name which are accessible to the authenticated user.
705 706 707 708 709 710 711

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

Parameters:

712 713 714 715 716
- `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