2014-05-27 08:12:15 -04:00
# Projects
2013-02-14 14:43:48 -05:00
2015-02-20 13:27:37 -05:00
### Project visibility level
Project in GitLab has be either private, internal or public.
2017-03-01 10:16:29 -05:00
You can determine it by `visibility` field in project.
2015-02-20 13:27:37 -05:00
Constants for project visibility levels are next:
2017-03-01 10:16:29 -05:00
* `private` :
2015-02-20 13:27:37 -05:00
Project access must be granted explicitly for each user.
2017-03-01 10:16:29 -05:00
* `internal` :
2015-02-20 13:27:37 -05:00
The project can be cloned by any logged in user.
2015-07-08 16:27:36 -04:00
2017-03-01 10:16:29 -05:00
* `public` :
2015-02-20 13:27:37 -05:00
The project can be cloned without any authentication.
2014-08-15 02:54:50 -04:00
## List projects
2012-07-05 09:57:45 -04:00
2017-03-06 08:04:20 -05:00
Get a list of visible projects for authenticated user. When being accessed without authentication, all public projects are returned.
2012-07-05 09:57:45 -04:00
```
GET /projects
```
2014-07-28 01:01:01 -04:00
Parameters:
2016-10-07 04:16:15 -04:00
| 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` |
2017-03-03 06:00:34 -05:00
| `search` | string | no | Return list of projects matching the search criteria |
2016-10-07 04:16:15 -04:00
| `simple` | boolean | no | Return only the ID, URL, name, and path of each project |
2017-02-01 05:23:57 -05:00
| `owned` | boolean | no | Limit by projects owned by the current user |
2017-03-03 06:00:34 -05:00
| `membership` | boolean | no | Limit by projects that the current user is a member of |
2017-02-01 05:23:57 -05:00
| `starred` | boolean | no | Limit by projects starred by the current user |
2014-07-28 01:01:01 -04:00
2012-07-05 09:57:45 -04:00
```json
[
{
2013-10-01 17:13:09 -04:00
"id": 4,
2012-07-05 09:57:45 -04:00
"description": null,
"default_branch": "master",
2017-03-01 10:16:29 -05:00
"visibility": "private",
2013-10-01 17:13:09 -04:00
"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",
2015-02-04 20:42:34 -05:00
"tag_list": [
"example",
"disapora client"
],
2012-07-05 09:57:45 -04:00
"owner": {
2013-10-01 17:13:09 -04:00
"id": 3,
"name": "Diaspora",
2016-06-27 09:56:33 -04:00
"created_at": "2013-09-30T13:46:02Z"
2012-07-05 09:57:45 -04:00
},
2013-10-01 17:13:09 -04:00
"name": "Diaspora Client",
"name_with_namespace": "Diaspora / Diaspora Client",
"path": "diaspora-client",
"path_with_namespace": "diaspora/diaspora-client",
"issues_enabled": true,
2015-12-12 02:17:36 -05:00
"open_issues_count": 1,
2013-10-01 17:13:09 -04:00
"merge_requests_enabled": true,
2017-03-06 04:24:03 -05:00
"jobs_enabled": true,
2012-07-05 09:57:45 -04:00
"wiki_enabled": true,
2013-10-01 17:13:09 -04:00
"snippets_enabled": false,
2016-06-27 16:33:51 -04:00
"container_registry_enabled": false,
2016-06-27 09:56:33 -04:00
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2015-04-10 14:05:01 -04:00
"creator_id": 3,
2013-10-01 17:13:09 -04:00
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
2017-02-14 09:03:24 -05:00
"kind": "group",
"full_path": "diaspora"
2014-04-20 06:01:55 -04:00
},
2015-02-28 12:07:53 -05:00
"archived": false,
2016-01-07 04:39:02 -05:00
"avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png",
"shared_runners_enabled": true,
"forks_count": 0,
2016-02-04 05:14:12 -05:00
"star_count": 0,
"runners_token": "b8547b1dc37721d05889db52fa2f02",
2017-03-06 04:24:03 -05:00
"public_jobs": true,
2016-08-21 23:47:58 -04:00
"shared_with_groups": [],
2017-02-17 08:56:13 -05:00
"only_allow_merge_if_pipeline_succeeds": false,
2016-09-16 07:02:42 -04:00
"only_allow_merge_if_all_discussions_are_resolved": false,
2016-09-14 18:04:27 -04:00
"request_access_enabled": false
2012-07-05 09:57:45 -04:00
},
{
2013-10-01 17:13:09 -04:00
"id": 6,
2012-07-05 09:57:45 -04:00
"description": null,
2013-10-01 17:13:09 -04:00
"default_branch": "master",
2017-03-01 10:16:29 -05:00
"visibility": "private",
2013-10-01 17:13:09 -04:00
"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",
2015-02-04 20:42:34 -05:00
"tag_list": [
"example",
"puppet"
],
2014-04-05 02:36:47 -04:00
"owner": {
2013-10-01 17:13:09 -04:00
"id": 4,
"name": "Brightbox",
"created_at": "2013-09-30T13:46:02Z"
2012-07-05 09:57:45 -04:00
},
2013-10-01 17:13:09 -04:00
"name": "Puppet",
"name_with_namespace": "Brightbox / Puppet",
"path": "puppet",
"path_with_namespace": "brightbox/puppet",
2012-07-05 09:57:45 -04:00
"issues_enabled": true,
2015-12-12 02:17:36 -05:00
"open_issues_count": 1,
2012-07-05 09:57:45 -04:00
"merge_requests_enabled": true,
2017-03-06 04:24:03 -05:00
"jobs_enabled": true,
2012-07-05 09:57:45 -04:00
"wiki_enabled": true,
2013-10-01 17:13:09 -04:00
"snippets_enabled": false,
2016-06-27 16:33:51 -04:00
"container_registry_enabled": false,
2013-10-01 17:13:09 -04:00
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2015-04-10 14:05:01 -04:00
"creator_id": 3,
2014-04-05 02:36:47 -04:00
"namespace": {
2013-10-01 17:13:09 -04:00
"id": 4,
"name": "Brightbox",
"path": "brightbox",
2017-02-14 09:03:24 -05:00
"kind": "group",
"full_path": "brightbox"
2014-04-20 06:01:55 -04:00
},
2015-12-13 14:43:17 -05:00
"permissions": {
"project_access": {
"access_level": 10,
"notification_level": 3
},
"group_access": {
"access_level": 50,
"notification_level": 3
}
},
2015-02-28 12:07:53 -05:00
"archived": false,
2016-01-07 04:39:02 -05:00
"avatar_url": null,
"shared_runners_enabled": true,
"forks_count": 0,
"star_count": 0,
2016-02-04 05:14:12 -05:00
"runners_token": "b8547b1dc37721d05889db52fa2f02",
2017-03-06 04:24:03 -05:00
"public_jobs": true,
2016-08-21 23:47:58 -04:00
"shared_with_groups": [],
2017-02-17 08:56:13 -05:00
"only_allow_merge_if_pipeline_succeeds": false,
2016-09-16 07:02:42 -04:00
"only_allow_merge_if_all_discussions_are_resolved": false,
2016-09-14 18:04:27 -04:00
"request_access_enabled": false
2012-07-05 09:57:45 -04:00
}
]
```
2013-02-14 14:43:48 -05:00
### Get single project
2012-07-05 09:57:45 -04:00
2014-07-31 12:39:04 -04:00
Get a specific project, identified by project ID or NAMESPACE/PROJECT_NAME, which is owned by the authenticated user.
2016-12-02 08:34:17 -05:00
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` ). This endpoint can be accessed without authentication if
the project is publicly accessible.
2012-07-05 09:57:45 -04:00
```
GET /projects/:id
```
Parameters:
2016-10-07 04:16:15 -04:00
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or NAMESPACE/PROJECT_NAME of the project |
2012-07-05 09:57:45 -04:00
2012-08-31 03:25:36 -04:00
```json
{
2013-10-01 17:13:09 -04:00
"id": 3,
2012-08-31 03:25:36 -04:00
"description": null,
2013-10-01 17:13:09 -04:00
"default_branch": "master",
2017-03-01 10:16:29 -05:00
"visibility": "private",
2013-10-01 17:13:09 -04:00
"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",
2015-02-04 20:42:34 -05:00
"tag_list": [
"example",
"disapora project"
],
2012-08-31 03:25:36 -04:00
"owner": {
2013-10-01 17:13:09 -04:00
"id": 3,
"name": "Diaspora",
2016-06-27 09:56:33 -04:00
"created_at": "2013-09-30T13:46:02Z"
2012-08-31 03:25:36 -04:00
},
2013-10-01 17:13:09 -04:00
"name": "Diaspora Project Site",
"name_with_namespace": "Diaspora / Diaspora Project Site",
"path": "diaspora-project-site",
"path_with_namespace": "diaspora/diaspora-project-site",
2012-08-31 03:25:36 -04:00
"issues_enabled": true,
2015-12-12 02:17:36 -05:00
"open_issues_count": 1,
2012-08-31 03:25:36 -04:00
"merge_requests_enabled": true,
2017-03-06 04:24:03 -05:00
"jobs_enabled": true,
2012-08-31 03:25:36 -04:00
"wiki_enabled": true,
2013-10-01 17:13:09 -04:00
"snippets_enabled": false,
2016-06-27 16:33:51 -04:00
"container_registry_enabled": false,
2016-06-27 09:56:33 -04:00
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2015-04-10 14:05:01 -04:00
"creator_id": 3,
2013-10-01 17:13:09 -04:00
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
2017-02-14 09:03:24 -05:00
"kind": "group",
"full_path": "diaspora"
2014-04-05 02:36:47 -04:00
},
2014-03-17 09:22:39 -04:00
"permissions": {
"project_access": {
"access_level": 10,
"notification_level": 3
},
"group_access": {
"access_level": 50,
"notification_level": 3
}
2014-04-20 06:01:55 -04:00
},
2015-02-28 12:07:53 -05:00
"archived": false,
2016-01-07 04:39:02 -05:00
"avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
"shared_runners_enabled": true,
"forks_count": 0,
"star_count": 0,
2016-07-08 03:34:36 -04:00
"runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
2017-03-06 04:24:03 -05:00
"public_jobs": true,
2016-07-08 03:34:36 -04:00
"shared_with_groups": [
{
"group_id": 4,
"group_name": "Twitter",
"group_access_level": 30
},
{
"group_id": 3,
"group_name": "Gitlab Org",
"group_access_level": 10
}
2016-08-21 23:47:58 -04:00
],
2017-02-17 08:56:13 -05:00
"only_allow_merge_if_pipeline_succeeds": false,
2016-09-16 07:02:42 -04:00
"only_allow_merge_if_all_discussions_are_resolved": false,
2016-09-14 18:04:27 -04:00
"request_access_enabled": false
2012-08-31 03:25:36 -04:00
}
```
2016-12-02 08:34:17 -05:00
## Get project users
Get the users list of a project.
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `search` | string | no | Search for specific users |
```
GET /projects/:id/users
```
```json
[
{
"id": 1,
"username": "john_smith",
"name": "John Smith",
"state": "active",
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/cd8.jpeg",
"web_url": "http://localhost:3000/john_smith"
},
{
"id": 2,
"username": "jack_smith",
"name": "Jack Smith",
"state": "blocked",
"avatar_url": "http://gravatar.com/../e32131cd8.jpeg",
"web_url": "http://localhost:3000/jack_smith"
}
]
```
2013-06-06 12:19:17 -04:00
### Get project events
2016-12-02 08:34:17 -05:00
Get the events for the specified project sorted from newest to oldest. This
endpoint can be accessed without authentication if the project is publicly
accessible.
2013-06-06 12:19:17 -04:00
```
GET /projects/:id/events
```
Parameters:
2016-10-07 04:16:15 -04:00
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or NAMESPACE/PROJECT_NAME of the project |
2013-06-06 12:19:17 -04:00
```json
2014-04-05 02:36:47 -04:00
[
{
"title": null,
"project_id": 15,
"action_name": "closed",
"target_id": 830,
"target_type": "Issue",
"author_id": 1,
"data": null,
2015-12-04 06:21:06 -05:00
"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",
2016-10-13 07:24:09 -04:00
"web_url": "http://localhost:3000/root"
2015-12-04 06:21:06 -05:00
},
"author_username": "root"
2014-04-05 02:36:47 -04:00
},
{
"title": null,
"project_id": 15,
"action_name": "opened",
"target_id": null,
"target_type": null,
"author_id": 1,
2015-12-04 06:21:06 -05:00
"author": {
"name": "Dmitriy Zaporozhets",
"username": "root",
"id": 1,
"state": "active",
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
2016-10-13 07:24:09 -04:00
"web_url": "http://localhost:3000/root"
2015-12-04 06:21:06 -05:00
},
2014-10-31 06:08:45 -04:00
"author_username": "john",
2014-04-05 02:36:47 -04:00
"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
2013-06-06 12:19:17 -04:00
},
2014-04-05 02:36:47 -04:00
"target_title": null
2013-06-06 12:19:17 -04:00
},
2014-04-05 02:36:47 -04:00
{
"title": null,
"project_id": 15,
"action_name": "closed",
"target_id": 840,
"target_type": "Issue",
"author_id": 1,
"data": null,
2015-12-04 06:21:06 -05:00
"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",
2016-10-13 07:24:09 -04:00
"web_url": "http://localhost:3000/root"
2015-12-04 06:21:06 -05:00
},
"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",
2016-10-13 07:24:09 -04:00
"web_url": "http://localhost:3000/root"
2015-12-04 06:21:06 -05:00
},
"created_at": "2015-12-04T10:33:56.698Z",
"system": 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",
2016-10-13 07:24:09 -04:00
"web_url": "http://localhost:3000/root"
2015-12-04 06:21:06 -05:00
},
"author_username": "root"
2014-04-05 02:36:47 -04:00
}
]
2013-06-06 12:19:17 -04:00
```
2013-02-14 14:43:48 -05:00
### Create project
2012-08-31 03:25:36 -04:00
2014-07-31 12:39:04 -04:00
Creates a new project owned by the authenticated user.
2012-08-31 03:25:36 -04:00
```
POST /projects
```
Parameters:
2016-10-07 04:16:15 -04:00
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-02-21 09:12:32 -05:00
| `name` | string | yes if path is not provided | The name of the new project. Equals path if not provided. |
| `path` | string | yes if name is not provided | Repository name for new project. Generated based on name if not provided (generated lowercased with dashes). |
2016-10-07 04:16:15 -04:00
| `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 |
2017-03-06 04:24:03 -05:00
| `jobs_enabled` | boolean | no | Enable jobs for this project |
2016-10-07 04:16:15 -04:00
| `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 |
2017-03-01 10:16:29 -05:00
| `visibility` | String | no | See [project visibility level ](#project-visibility-level ) |
2016-10-07 04:16:15 -04:00
| `import_url` | string | no | URL to import repository from |
2017-03-06 04:24:03 -05:00
| `public_jobs` | boolean | no | If `true` , jobs can be viewed by non-project-members |
| `only_allow_merge_if_pipeline_succeeds` | boolean | no | Set whether merge requests can only be merged with successful jobs |
2016-09-16 07:02:42 -04:00
| `only_allow_merge_if_all_discussions_are_resolved` | boolean | no | Set whether merge requests can only be merged when all the discussions are resolved |
2016-10-07 04:16:15 -04:00
| `lfs_enabled` | boolean | no | Enable LFS |
| `request_access_enabled` | boolean | no | Allow users to request member access |
2013-02-27 10:49:45 -05:00
2013-03-07 08:51:56 -05:00
### Create project for user
2014-07-31 12:39:04 -04:00
Creates a new project owned by the specified user. Available only for admins.
2013-03-05 23:48:40 -05:00
```
POST /projects/user/:user_id
```
Parameters:
2016-10-07 04:16:15 -04:00
| 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 |
2016-11-24 09:29:22 -05:00
| `default_branch` | string | no | `master` by default |
2016-10-07 04:16:15 -04:00
| `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 |
2017-03-06 04:24:03 -05:00
| `jobs_enabled` | boolean | no | Enable jobs for this project |
2016-10-07 04:16:15 -04:00
| `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 |
2017-03-01 10:16:29 -05:00
| `visibility` | string | no | See [project visibility level ](#project-visibility-level ) |
2016-10-07 04:16:15 -04:00
| `import_url` | string | no | URL to import repository from |
2017-03-06 04:24:03 -05:00
| `public_jobs` | boolean | no | If `true` , jobs can be viewed by non-project-members |
| `only_allow_merge_if_pipeline_succeeds` | boolean | no | Set whether merge requests can only be merged with successful jobs |
2016-09-16 07:02:42 -04:00
| `only_allow_merge_if_all_discussions_are_resolved` | boolean | no | Set whether merge requests can only be merged when all the discussions are resolved |
2016-10-07 04:16:15 -04:00
| `lfs_enabled` | boolean | no | Enable LFS |
| `request_access_enabled` | boolean | no | Allow users to request member access |
2012-08-31 03:25:36 -04:00
2014-10-15 02:57:35 -04:00
### Edit project
2016-11-24 12:28:52 -05:00
Updates an existing project.
2014-10-15 02:57:35 -04:00
```
PUT /projects/:id
```
Parameters:
2016-10-07 04:16:15 -04:00
| 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 |
2016-11-23 19:27:22 -05:00
| `default_branch` | string | no | `master` by default |
2016-10-07 04:16:15 -04:00
| `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 |
2017-03-06 04:24:03 -05:00
| `jobs_enabled` | boolean | no | Enable jobs for this project |
2016-10-07 04:16:15 -04:00
| `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 |
2017-03-01 10:16:29 -05:00
| `visibility` | string | no | See [project visibility level ](#project-visibility-level ) |
2016-10-07 04:16:15 -04:00
| `import_url` | string | no | URL to import repository from |
2017-03-06 04:24:03 -05:00
| `public_jobs` | boolean | no | If `true` , jobs can be viewed by non-project-members |
| `only_allow_merge_if_pipeline_succeeds` | boolean | no | Set whether merge requests can only be merged with successful jobs |
2016-09-16 07:02:42 -04:00
| `only_allow_merge_if_all_discussions_are_resolved` | boolean | no | Set whether merge requests can only be merged when all the discussions are resolved |
2016-10-07 04:16:15 -04:00
| `lfs_enabled` | boolean | no | Enable LFS |
| `request_access_enabled` | boolean | no | Allow users to request member access |
2014-10-15 02:57:35 -04:00
2014-10-01 04:20:40 -04:00
### Fork project
2016-09-05 20:31:06 -04:00
Forks a project into the user namespace of the authenticated user or the one provided.
2014-10-01 04:20:40 -04:00
```
2017-02-02 12:57:34 -05:00
POST /projects/:id/fork
2014-10-01 04:20:40 -04:00
```
Parameters:
2016-10-07 04:16:15 -04:00
| 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 |
2014-10-01 04:20:40 -04:00
2016-04-06 09:52:16 -04:00
### Star a project
2016-11-24 12:28:52 -05:00
Stars a given project. Returns status code `304` if the project is already starred.
2016-04-06 09:52:16 -04:00
```
POST /projects/:id/star
```
2016-10-07 04:16:15 -04:00
Parameters:
2016-04-06 09:52:16 -04:00
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2016-10-07 04:16:15 -04:00
| `id` | integer/string | yes | The ID or NAMESPACE/PROJECT_NAME of the project |
2016-04-06 09:52:16 -04:00
```bash
2017-03-01 12:39:40 -05:00
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/5/star"
2016-04-06 09:52:16 -04:00
```
Example response:
```json
{
"id": 3,
"description": null,
"default_branch": "master",
2017-03-01 10:16:29 -05:00
"visibility": "internal",
2016-04-06 09:52:16 -04:00
"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,
2017-03-06 04:24:03 -05:00
"jobs_enabled": true,
2016-04-06 09:52:16 -04:00
"wiki_enabled": true,
"snippets_enabled": false,
2016-06-27 16:33:51 -04:00
"container_registry_enabled": false,
2016-06-27 09:56:33 -04:00
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2016-04-06 09:52:16 -04:00
"creator_id": 3,
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
2017-02-14 09:03:24 -05:00
"kind": "group",
"full_path": "diaspora"
2016-04-06 09:52:16 -04:00
},
"archived": true,
"avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
"shared_runners_enabled": true,
"forks_count": 0,
2016-07-08 03:34:36 -04:00
"star_count": 1,
2017-03-06 04:24:03 -05:00
"public_jobs": true,
2016-08-21 23:47:58 -04:00
"shared_with_groups": [],
2017-02-17 08:56:13 -05:00
"only_allow_merge_if_pipeline_succeeds": false,
2016-09-16 07:02:42 -04:00
"only_allow_merge_if_all_discussions_are_resolved": false,
2016-09-14 18:04:27 -04:00
"request_access_enabled": false
2016-04-06 09:52:16 -04:00
}
```
### Unstar a project
2016-11-24 12:28:52 -05:00
Unstars a given project. Returns status code `304` if the project is not starred.
2016-04-06 09:52:16 -04:00
```
2017-02-20 09:14:48 -05:00
POST /projects/:id/unstar
2016-04-06 09:52:16 -04:00
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2016-10-07 04:16:15 -04:00
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
2016-04-06 09:52:16 -04:00
```bash
2017-03-01 12:39:40 -05:00
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/5/unstar"
2016-04-06 09:52:16 -04:00
```
Example response:
```json
{
"id": 3,
"description": null,
"default_branch": "master",
2017-03-01 10:16:29 -05:00
"visibility": "internal",
2016-04-06 09:52:16 -04:00
"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,
2017-03-06 04:24:03 -05:00
"jobs_enabled": true,
2016-04-06 09:52:16 -04:00
"wiki_enabled": true,
"snippets_enabled": false,
2016-06-27 16:33:51 -04:00
"container_registry_enabled": false,
2016-06-27 09:56:33 -04:00
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2016-04-06 09:52:16 -04:00
"creator_id": 3,
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
2017-02-14 09:03:24 -05:00
"kind": "group",
"full_path": "diaspora"
2016-04-06 09:52:16 -04:00
},
"archived": true,
"avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
"shared_runners_enabled": true,
"forks_count": 0,
2016-07-08 03:34:36 -04:00
"star_count": 0,
2017-03-06 04:24:03 -05:00
"public_jobs": true,
2016-08-21 23:47:58 -04:00
"shared_with_groups": [],
2017-02-17 08:56:13 -05:00
"only_allow_merge_if_pipeline_succeeds": false,
2016-09-16 07:02:42 -04:00
"only_allow_merge_if_all_discussions_are_resolved": false,
2016-09-14 18:04:27 -04:00
"request_access_enabled": false
2016-04-06 09:52:16 -04:00
}
```
2016-03-23 17:36:35 -04:00
### Archive a project
2016-03-24 08:36:45 -04:00
Archives the project if the user is either admin or the project owner of this project. This action is
2016-03-23 17:36:35 -04:00
idempotent, thus archiving an already archived project will not change the project.
```
2016-03-24 08:36:45 -04:00
POST /projects/:id/archive
2016-03-23 17:36:35 -04:00
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2016-10-07 04:16:15 -04:00
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
2016-03-23 17:36:35 -04:00
```bash
2017-03-01 12:39:40 -05:00
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/5/archive"
2016-03-23 17:36:35 -04:00
```
Example response:
```json
{
"id": 3,
"description": null,
"default_branch": "master",
2017-03-01 10:16:29 -05:00
"visibility": "private",
2016-03-23 17:36:35 -04:00
"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",
2016-06-27 09:56:33 -04:00
"created_at": "2013-09-30T13:46:02Z"
2016-03-23 17:36:35 -04:00
},
"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,
2017-03-06 04:24:03 -05:00
"jobs_enabled": true,
2016-03-23 17:36:35 -04:00
"wiki_enabled": true,
"snippets_enabled": false,
2016-06-27 16:33:51 -04:00
"container_registry_enabled": false,
2016-06-27 09:56:33 -04:00
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2016-03-23 17:36:35 -04:00
"creator_id": 3,
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
2017-02-14 09:03:24 -05:00
"kind": "group",
"full_path": "diaspora"
2016-03-23 17:36:35 -04:00
},
"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,
2016-07-08 03:34:36 -04:00
"runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
2017-03-06 04:24:03 -05:00
"public_jobs": true,
2016-08-21 23:47:58 -04:00
"shared_with_groups": [],
2017-02-17 08:56:13 -05:00
"only_allow_merge_if_pipeline_succeeds": false,
2016-09-16 07:02:42 -04:00
"only_allow_merge_if_all_discussions_are_resolved": false,
2016-09-14 18:04:27 -04:00
"request_access_enabled": false
2016-03-23 17:36:35 -04:00
}
```
### Unarchive a project
2016-03-24 08:36:45 -04:00
Unarchives the project if the user is either admin or the project owner of this project. This action is
2016-03-23 17:36:35 -04:00
idempotent, thus unarchiving an non-archived project will not change the project.
```
2016-07-07 08:41:15 -04:00
POST /projects/:id/unarchive
2016-03-23 17:36:35 -04:00
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2016-10-07 04:16:15 -04:00
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
2016-03-23 17:36:35 -04:00
```bash
2017-03-01 12:39:40 -05:00
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/5/unarchive"
2016-03-23 17:36:35 -04:00
```
Example response:
```json
{
"id": 3,
"description": null,
"default_branch": "master",
2017-03-01 10:16:29 -05:00
"visibility": "private",
2016-03-23 17:36:35 -04:00
"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",
2016-06-27 09:56:33 -04:00
"created_at": "2013-09-30T13:46:02Z"
2016-03-23 17:36:35 -04:00
},
"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,
2017-03-06 04:24:03 -05:00
"jobs_enabled": true,
2016-03-23 17:36:35 -04:00
"wiki_enabled": true,
"snippets_enabled": false,
2016-06-27 16:33:51 -04:00
"container_registry_enabled": false,
2016-06-27 09:56:33 -04:00
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2016-03-23 17:36:35 -04:00
"creator_id": 3,
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
2017-02-14 09:03:24 -05:00
"kind": "group",
"full_path": "diaspora"
2016-03-23 17:36:35 -04:00
},
"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,
2016-07-08 03:34:36 -04:00
"runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
2017-03-06 04:24:03 -05:00
"public_jobs": true,
2016-08-21 23:47:58 -04:00
"shared_with_groups": [],
2017-02-17 08:56:13 -05:00
"only_allow_merge_if_pipeline_succeeds": false,
2016-09-16 07:02:42 -04:00
"only_allow_merge_if_all_discussions_are_resolved": false,
2016-09-14 18:04:27 -04:00
"request_access_enabled": false
2016-03-23 17:36:35 -04:00
}
```
2014-08-15 02:54:50 -04:00
### Remove project
2013-10-09 07:43:18 -04:00
2014-07-31 12:39:04 -04:00
Removes a project including all associated resources (issues, merge requests etc.)
2013-10-09 07:43:18 -04:00
```
DELETE /projects/:id
```
Parameters:
2016-10-07 04:16:15 -04:00
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
2013-03-07 08:51:56 -05:00
2016-01-07 07:37:14 -05:00
## 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:
2016-10-07 04:16:15 -04:00
| 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 |
2016-01-07 07:37:14 -05:00
```json
{
"alt": "dk",
"url": "/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png",
"markdown": ""
}
```
**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.
2016-06-23 11:14:31 -04:00
## Project members
2013-03-07 08:51:56 -05:00
2016-06-23 11:14:31 -04:00
Please consult the [Project Members ](members.md ) documentation.
2012-07-05 09:57:45 -04:00
2016-03-13 06:46:16 -04:00
### Share project with group
Allow to share project with group.
```
POST /projects/:id/share
```
Parameters:
2016-10-07 04:16:15 -04:00
| 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 |
2016-03-13 06:46:16 -04:00
2016-11-22 05:23:41 -05:00
### Delete a shared project link within a group
Unshare the project from the group. Returns `204` and no content on success.
```
DELETE /projects/:id/share/:group_id
```
Parameters:
| 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 |
```bash
2017-03-01 12:39:40 -05:00
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/share/17
2016-11-22 05:23:41 -05:00
```
2013-02-14 14:43:48 -05:00
## Hooks
2015-07-08 16:27:36 -04:00
Also called Project Hooks and Webhooks.
These are different for [System Hooks ](system_hooks.md ) that are system wide.
2013-02-14 14:43:48 -05:00
### List project hooks
2014-07-31 12:39:04 -04:00
Get a list of project hooks.
2012-09-08 13:51:12 -04:00
```
GET /projects/:id/hooks
```
Parameters:
2016-10-07 04:16:15 -04:00
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
2012-09-08 13:51:12 -04:00
2013-02-14 14:43:48 -05:00
### Get project hook
2012-10-12 03:38:15 -04:00
2014-07-31 12:39:04 -04:00
Get a specific hook for a project.
2012-10-12 03:38:15 -04:00
```
GET /projects/:id/hooks/:hook_id
```
2013-02-14 14:43:48 -05:00
Parameters:
2012-10-12 03:38:15 -04:00
2016-10-07 04:16:15 -04:00
| 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 |
2012-10-12 03:38:15 -04:00
2013-02-14 14:43:48 -05:00
```json
{
"id": 1,
"url": "http://example.com/hook",
2013-12-04 06:35:38 -05:00
"project_id": 3,
2016-06-27 09:56:33 -04:00
"push_events": true,
"issues_events": true,
"merge_requests_events": true,
2016-08-23 14:51:05 -04:00
"tag_push_events": true,
2016-06-27 09:56:33 -04:00
"note_events": true,
2017-03-06 04:24:03 -05:00
"job_events": true,
2016-08-23 14:51:05 -04:00
"pipeline_events": true,
2016-08-23 14:54:44 -04:00
"wiki_page_events": true,
2016-06-27 09:56:33 -04:00
"enable_ssl_verification": true,
2013-02-14 14:43:48 -05:00
"created_at": "2012-10-12T17:04:47Z"
}
```
### Add project hook
2014-07-31 12:39:04 -04:00
Adds a hook to a specified project.
2012-09-08 13:51:12 -04:00
```
POST /projects/:id/hooks
```
Parameters:
2016-10-07 04:16:15 -04:00
| 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 |
2017-03-06 04:24:03 -05:00
| `job_events` | boolean | no | Trigger hook on job events |
2016-10-07 04:16:15 -04:00
| `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 |
2016-11-01 07:40:06 -04:00
| `token` | string | no | Secret token to validate received payloads; this will not be returned in the response |
2012-10-12 03:38:15 -04:00
2013-02-14 14:43:48 -05:00
### Edit project hook
2014-07-31 12:39:04 -04:00
Edits a hook for a specified project.
2012-10-12 03:38:15 -04:00
```
PUT /projects/:id/hooks/:hook_id
```
Parameters:
2016-10-07 04:16:15 -04:00
| 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 |
2017-03-06 04:24:03 -05:00
| `job_events` | boolean | no | Trigger hook on job events |
2016-10-07 04:16:15 -04:00
| `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 |
2016-11-01 07:40:06 -04:00
| `token` | string | no | Secret token to validate received payloads; this will not be returned in the response |
2012-10-12 03:38:15 -04:00
2013-02-14 14:43:48 -05:00
### Delete project hook
2012-09-08 13:51:12 -04:00
2014-07-31 12:39:04 -04:00
Removes a hook from a project. This is an idempotent method and can be called multiple times.
2013-02-14 14:43:48 -05:00
Either the hook is available or not.
2012-09-08 13:51:12 -04:00
```
2013-04-25 08:47:04 -04:00
DELETE /projects/:id/hooks/:hook_id
2012-09-08 13:51:12 -04:00
```
Parameters:
2016-10-07 04:16:15 -04:00
| 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 |
2012-09-08 13:51:12 -04:00
2013-02-14 14:43:48 -05:00
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.
2013-02-15 07:54:26 -05:00
## Branches
2016-08-25 08:01:52 -04:00
For more information please consult the [Branches ](branches.md ) documentation.
2013-02-15 07:54:26 -05:00
### List branches
Lists all branches of a project.
```
GET /projects/:id/repository/branches
```
Parameters:
2016-10-07 04:16:15 -04:00
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
2013-02-15 07:54:26 -05:00
2013-10-01 17:13:09 -04:00
```json
[
{
2014-04-05 02:36:47 -04:00
"name": "async",
2013-10-01 17:13:09 -04:00
"commit": {
2014-04-05 02:36:47 -04:00
"id": "a2b702edecdf41f07b42653eb1abe30ce98b9fca",
2016-08-25 08:01:52 -04:00
"parent_ids": [
"3f94fc7c85061973edc9906ae170cc269b07ca55"
2014-04-05 02:36:47 -04:00
],
2015-02-03 18:18:40 -05:00
"message": "give Caolan credit where it's due (up top)",
2016-08-25 08:01:52 -04:00
"author_name": "Jeremy Ashkenas",
"author_email": "jashkenas@example.com",
2014-04-05 02:36:47 -04:00
"authored_date": "2010-12-08T21:28:50+00:00",
2016-08-25 08:01:52 -04:00
"committer_name": "Jeremy Ashkenas",
"committer_email": "jashkenas@example.com",
2014-04-05 02:36:47 -04:00
"committed_date": "2010-12-08T21:28:50+00:00"
2013-10-01 17:13:09 -04:00
},
2016-08-25 08:01:52 -04:00
"protected": false,
"developers_can_push": false,
"developers_can_merge": false
2013-10-01 17:13:09 -04:00
},
{
"name": "gh-pages",
"commit": {
"id": "101c10a60019fe870d21868835f65c25d64968fc",
2016-08-25 08:01:52 -04:00
"parent_ids": [
"9c15d2e26945a665131af5d7b6d30a06ba338aaa"
2014-04-05 02:36:47 -04:00
],
2013-10-01 17:13:09 -04:00
"message": "Underscore.js 1.5.2",
2016-08-25 08:01:52 -04:00
"author_name": "Jeremy Ashkenas",
"author_email": "jashkenas@example.com",
2016-06-27 09:56:33 -04:00
"authored_date": "2013-09-07T12:58:21+00:00",
2016-08-25 08:01:52 -04:00
"committer_name": "Jeremy Ashkenas",
"committer_email": "jashkenas@example.com",
2016-06-27 09:56:33 -04:00
"committed_date": "2013-09-07T12:58:21+00:00"
2013-10-01 17:13:09 -04:00
},
2016-08-25 08:01:52 -04:00
"protected": false,
"developers_can_push": false,
"developers_can_merge": false
2013-10-01 17:13:09 -04:00
}
]
```
2013-02-15 07:54:26 -05:00
2016-08-25 08:01:52 -04:00
### Single branch
2013-02-15 07:54:26 -05:00
2016-08-25 08:01:52 -04:00
A specific branch of a project.
2013-02-15 07:54:26 -05:00
```
GET /projects/:id/repository/branches/:branch
```
Parameters:
2016-10-07 04:16:15 -04:00
| 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 |
2013-02-15 07:54:26 -05:00
### Protect single branch
Protects a single branch of a project.
```
PUT /projects/:id/repository/branches/:branch/protect
```
Parameters:
2016-10-07 04:16:15 -04:00
| 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 |
2013-02-15 07:54:26 -05:00
### Unprotect single branch
Unprotects a single branch of a project.
```
PUT /projects/:id/repository/branches/:branch/unprotect
```
Parameters:
2016-10-07 04:16:15 -04:00
| 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 |
2013-06-27 17:49:26 -04:00
## Admin fork relation
2014-07-31 12:39:04 -04:00
Allows modification of the forked relationship between existing projects. Available only for admins.
2013-06-27 17:49:26 -04:00
### Create a forked from/to relation between existing projects.
```
POST /projects/:id/fork/:forked_from_id
```
Parameters:
2016-10-07 04:16:15 -04:00
| 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 |
2013-06-27 17:49:26 -04:00
### Delete an existing forked from relationship
```
DELETE /projects/:id/fork
```
Parameter:
2016-10-07 04:16:15 -04:00
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
2013-09-23 19:18:29 -04:00
## Search for projects by name
2016-12-02 08:34:17 -05:00
Search for projects by name which are accessible to the authenticated user. This
endpoint can be accessed without authentication if the project is publicly
accessible.
2013-09-23 19:18:29 -04:00
```
GET /projects/search/:query
```
Parameters:
2016-10-07 04:16:15 -04:00
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2016-10-19 19:57:23 -04:00
| `query` | string | yes | A string contained in the project name |
| `order_by` | string | no | Return requests ordered by `id` , `name` , `created_at` or `last_activity_at` fields |
2017-02-20 09:14:48 -05:00
| `sort` | string | no | Return requests sorted in `asc` or `desc` order |
2017-02-21 09:51:31 -05:00
## Start the Housekeeping task for a Project
>**Note:** This feature was introduced in GitLab 9.0
```
POST /projects/:id/housekeeping
```
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
