debian-mirror-gitlab/doc/api/projects.md

1588 lines
57 KiB
Markdown
Raw Normal View History

2017-09-10 17:25:29 +05:30
# Projects API
2015-04-26 12:48:37 +05:30
2018-03-17 18:26:18 +05:30
## Project visibility level
2015-04-26 12:48:37 +05:30
2017-09-10 17:25:29 +05:30
Project in GitLab can be either private, internal or public.
This is determined by the `visibility` field in the project.
2015-04-26 12:48:37 +05:30
2017-09-10 17:25:29 +05:30
Values for the project visibility level are:
2015-04-26 12:48:37 +05:30
2019-03-02 22:35:43 +05:30
- `private`:
2015-04-26 12:48:37 +05:30
Project access must be granted explicitly for each user.
2019-03-02 22:35:43 +05:30
- `internal`:
2015-04-26 12:48:37 +05:30
The project can be cloned by any logged in user.
2015-09-11 14:41:01 +05:30
2019-03-02 22:35:43 +05:30
- `public`:
2015-04-26 12:48:37 +05:30
The project can be cloned without any authentication.
2018-05-09 12:01:36 +05:30
## Project merge method
There are currently three options for `merge_method` to choose from:
2019-03-02 22:35:43 +05:30
- `merge`:
2018-05-09 12:01:36 +05:30
A merge commit is created for every merge, and merging is allowed as long as there are no conflicts.
2019-03-02 22:35:43 +05:30
- `rebase_merge`:
2018-05-09 12:01:36 +05:30
A merge commit is created for every merge, but merging is only allowed if fast-forward merge is possible.
This way you could make sure that if this merge request would build, after merging to target branch it would also build.
2019-03-02 22:35:43 +05:30
- `ff`:
2018-05-09 12:01:36 +05:30
No merge commits are created and all merges are fast-forwarded, which means that merging is only allowed if the branch could be fast-forwarded.
2018-03-17 18:26:18 +05:30
## List all projects
2014-09-02 18:07:02 +05:30
2018-03-17 18:26:18 +05:30
Get a list of all visible projects across GitLab for the authenticated user.
2018-11-18 11:00:15 +05:30
When accessed without authentication, only public projects with "simple" fields are returned.
2014-09-02 18:07:02 +05:30
```
GET /projects
```
2016-11-03 12:29:30 +05:30
| 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-08-17 22:00:37 +05:30
| `search` | string | no | Return list of projects matching the search criteria |
2018-11-18 11:00:15 +05:30
| `simple` | boolean | no | Return only limited fields for each project. This is a no-op without authentication as then _only_ simple fields are returned. |
| `owned` | boolean | no | Limit by projects explicitly owned by the current user |
2017-08-17 22:00:37 +05:30
| `membership` | boolean | no | Limit by projects that the current user is a member of |
| `starred` | boolean | no | Limit by projects starred by the current user |
| `statistics` | boolean | no | Include project statistics |
2018-03-27 19:54:05 +05:30
| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) |
2017-09-10 17:25:29 +05:30
| `with_issues_enabled` | boolean | no | Limit by enabled issues feature |
| `with_merge_requests_enabled` | boolean | no | Limit by enabled merge requests feature |
2019-03-02 22:35:43 +05:30
| `with_programming_language` | string | no | Limit by projects which use the given programming language |
2018-11-18 11:00:15 +05:30
| `wiki_checksum_failed` | boolean | no | Limit projects where the wiki checksum calculation has failed _([Introduced][ee-6137] in [GitLab Premium][eep] 11.2)_ |
| `repository_checksum_failed` | boolean | no | Limit projects where the repository checksum calculation has failed _([Introduced][ee-6137] in [GitLab Premium][eep] 11.2)_ |
| `min_access_level` | integer | no | Limit by current user minimal [access level](members.md) |
When `simple=true` or the user is unauthenticated this returns something like:
```json
[
{
"id": 4,
"description": null,
"default_branch": "master",
"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",
"readme_url": "http://example.com/diaspora/diaspora-client/blob/master/README.md",
"tag_list": [
"example",
"disapora client"
],
"name": "Diaspora Client",
"name_with_namespace": "Diaspora / Diaspora Client",
"path": "diaspora-client",
"path_with_namespace": "diaspora/diaspora-client",
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
"forks_count": 0,
"avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png",
"star_count": 0,
},
{
"id": 6,
"description": null,
"default_branch": "master",
...
```
When the user is authenticated and `simple` is not set this returns something like:
2017-09-10 17:25:29 +05:30
```json
[
{
"id": 4,
"description": null,
"default_branch": "master",
"visibility": "private",
"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",
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-client/blob/master/README.md",
2017-09-10 17:25:29 +05:30
"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,
"jobs_enabled": true,
"wiki_enabled": true,
"snippets_enabled": false,
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
2017-09-10 17:25:29 +05:30
"container_registry_enabled": false,
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
"creator_id": 3,
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
"kind": "group",
"full_path": "diaspora"
},
"import_status": "none",
"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_jobs": true,
"shared_with_groups": [],
"only_allow_merge_if_pipeline_succeeds": false,
"only_allow_merge_if_all_discussions_are_resolved": false,
"request_access_enabled": false,
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
2017-09-10 17:25:29 +05:30
"statistics": {
"commit_count": 37,
"storage_size": 1038090,
"repository_size": 1038090,
"lfs_objects_size": 0,
"job_artifacts_size": 0
},
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
"merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
"repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
"labels": "http://example.com/api/v4/projects/1/labels",
"events": "http://example.com/api/v4/projects/1/events",
"members": "http://example.com/api/v4/projects/1/members"
},
},
{
"id": 6,
"description": null,
"default_branch": "master",
"visibility": "private",
"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",
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/brightbox/puppet/blob/master/README.md",
2017-09-10 17:25:29 +05:30
"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,
"jobs_enabled": true,
"wiki_enabled": true,
"snippets_enabled": false,
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
2017-09-10 17:25:29 +05:30
"container_registry_enabled": false,
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
"creator_id": 3,
"namespace": {
"id": 4,
"name": "Brightbox",
"path": "brightbox",
"kind": "group",
"full_path": "brightbox"
},
"import_status": "none",
"import_error": null,
"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_jobs": true,
"shared_with_groups": [],
"only_allow_merge_if_pipeline_succeeds": false,
"only_allow_merge_if_all_discussions_are_resolved": false,
"request_access_enabled": false,
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
2017-09-10 17:25:29 +05:30
"statistics": {
"commit_count": 12,
"storage_size": 2066080,
"repository_size": 2066080,
"lfs_objects_size": 0,
"job_artifacts_size": 0
},
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
"merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
"repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
"labels": "http://example.com/api/v4/projects/1/labels",
"events": "http://example.com/api/v4/projects/1/events",
"members": "http://example.com/api/v4/projects/1/members"
}
}
]
```
2018-03-17 18:26:18 +05:30
You can filter by [custom attributes](custom_attributes.md) with:
```
GET /projects?custom_attributes[key]=value&custom_attributes[other_key]=other_value
```
## List user projects
2017-09-10 17:25:29 +05:30
2018-11-20 20:47:30 +05:30
Get a list of visible projects owned by the given user. When accessed without authentication, only public projects are returned.
2017-09-10 17:25:29 +05:30
```
GET /users/:user_id/projects
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `user_id` | string | yes | The ID or username of the user |
| `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 projects matching the search criteria |
2018-11-18 11:00:15 +05:30
| `simple` | boolean | no | Return only limited fields for each project. This is a no-op without authentication as then _only_ simple fields are returned. |
| `owned` | boolean | no | Limit by projects explicitly owned by the current user |
2017-09-10 17:25:29 +05:30
| `membership` | boolean | no | Limit by projects that the current user is a member of |
| `starred` | boolean | no | Limit by projects starred by the current user |
| `statistics` | boolean | no | Include project statistics |
2018-03-27 19:54:05 +05:30
| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) |
2017-09-10 17:25:29 +05:30
| `with_issues_enabled` | boolean | no | Limit by enabled issues feature |
| `with_merge_requests_enabled` | boolean | no | Limit by enabled merge requests feature |
2019-03-02 22:35:43 +05:30
| `with_programming_language` | string | no | Limit by projects which use the given programming language |
2018-11-18 11:00:15 +05:30
| `min_access_level` | integer | no | Limit by current user minimal [access level](members.md) |
2014-09-02 18:07:02 +05:30
```json
[
{
"id": 4,
"description": null,
"default_branch": "master",
2017-08-17 22:00:37 +05:30
"visibility": "private",
2014-09-02 18:07:02 +05:30
"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",
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-client/blob/master/README.md",
2015-04-26 12:48:37 +05:30
"tag_list": [
"example",
"disapora client"
],
2014-09-02 18:07:02 +05:30
"owner": {
"id": 3,
"name": "Diaspora",
2016-08-24 12:49:21 +05:30
"created_at": "2013-09-30T13:46:02Z"
2014-09-02 18:07:02 +05:30
},
"name": "Diaspora Client",
"name_with_namespace": "Diaspora / Diaspora Client",
"path": "diaspora-client",
"path_with_namespace": "diaspora/diaspora-client",
"issues_enabled": true,
2015-12-23 02:04:40 +05:30
"open_issues_count": 1,
2014-09-02 18:07:02 +05:30
"merge_requests_enabled": true,
2017-08-17 22:00:37 +05:30
"jobs_enabled": true,
2014-09-02 18:07:02 +05:30
"wiki_enabled": true,
"snippets_enabled": false,
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
2016-08-24 12:49:21 +05:30
"container_registry_enabled": false,
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2015-04-26 12:48:37 +05:30
"creator_id": 3,
2014-09-02 18:07:02 +05:30
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
2017-08-17 22:00:37 +05:30
"kind": "group",
"full_path": "diaspora"
2014-09-02 18:07:02 +05:30
},
2017-09-10 17:25:29 +05:30
"import_status": "none",
2015-04-26 12:48:37 +05:30
"archived": false,
"avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png",
"shared_runners_enabled": true,
"forks_count": 0,
2016-04-02 18:10:28 +05:30
"star_count": 0,
"runners_token": "b8547b1dc37721d05889db52fa2f02",
2017-08-17 22:00:37 +05:30
"public_jobs": true,
2016-09-29 09:46:39 +05:30
"shared_with_groups": [],
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_pipeline_succeeds": false,
"only_allow_merge_if_all_discussions_are_resolved": false,
"request_access_enabled": false,
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
2017-08-17 22:00:37 +05:30
"statistics": {
"commit_count": 37,
"storage_size": 1038090,
"repository_size": 1038090,
"lfs_objects_size": 0,
"job_artifacts_size": 0
2017-09-10 17:25:29 +05:30
},
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
"merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
"repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
"labels": "http://example.com/api/v4/projects/1/labels",
"events": "http://example.com/api/v4/projects/1/events",
"members": "http://example.com/api/v4/projects/1/members"
2017-08-17 22:00:37 +05:30
}
2014-09-02 18:07:02 +05:30
},
{
"id": 6,
"description": null,
"default_branch": "master",
2017-08-17 22:00:37 +05:30
"visibility": "private",
2014-09-02 18:07:02 +05:30
"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",
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/brightbox/puppet/blob/master/README.md",
2015-04-26 12:48:37 +05:30
"tag_list": [
"example",
"puppet"
],
2014-09-02 18:07:02 +05:30
"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,
2015-12-23 02:04:40 +05:30
"open_issues_count": 1,
2014-09-02 18:07:02 +05:30
"merge_requests_enabled": true,
2017-08-17 22:00:37 +05:30
"jobs_enabled": true,
2014-09-02 18:07:02 +05:30
"wiki_enabled": true,
"snippets_enabled": false,
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
2016-08-24 12:49:21 +05:30
"container_registry_enabled": false,
2014-09-02 18:07:02 +05:30
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2015-04-26 12:48:37 +05:30
"creator_id": 3,
2014-09-02 18:07:02 +05:30
"namespace": {
"id": 4,
"name": "Brightbox",
"path": "brightbox",
2017-08-17 22:00:37 +05:30
"kind": "group",
"full_path": "brightbox"
2014-09-02 18:07:02 +05:30
},
2017-09-10 17:25:29 +05:30
"import_status": "none",
"import_error": null,
"permissions": {
"project_access": {
"access_level": 10,
"notification_level": 3
},
"group_access": {
"access_level": 50,
"notification_level": 3
}
},
2015-04-26 12:48:37 +05:30
"archived": false,
"avatar_url": null,
"shared_runners_enabled": true,
"forks_count": 0,
"star_count": 0,
2016-04-02 18:10:28 +05:30
"runners_token": "b8547b1dc37721d05889db52fa2f02",
2017-08-17 22:00:37 +05:30
"public_jobs": true,
2016-09-29 09:46:39 +05:30
"shared_with_groups": [],
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_pipeline_succeeds": false,
"only_allow_merge_if_all_discussions_are_resolved": false,
"request_access_enabled": false,
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
2017-08-17 22:00:37 +05:30
"statistics": {
"commit_count": 12,
"storage_size": 2066080,
"repository_size": 2066080,
"lfs_objects_size": 0,
"job_artifacts_size": 0
2017-09-10 17:25:29 +05:30
},
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
"merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
"repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
"labels": "http://example.com/api/v4/projects/1/labels",
"events": "http://example.com/api/v4/projects/1/events",
"members": "http://example.com/api/v4/projects/1/members"
2017-08-17 22:00:37 +05:30
}
2016-11-03 12:29:30 +05:30
}
]
```
2018-03-17 18:26:18 +05:30
## Get single project
2014-09-02 18:07:02 +05:30
2017-08-17 22:00:37 +05:30
Get a specific project. This endpoint can be accessed without authentication if
the project is publicly accessible.
2014-09-02 18:07:02 +05:30
```
GET /projects/:id
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
| `statistics` | boolean | no | Include project statistics |
2018-12-13 13:39:08 +05:30
| `license` | boolean | no | Include project license data |
2018-03-27 19:54:05 +05:30
| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) |
2014-09-02 18:07:02 +05:30
```json
{
"id": 3,
"description": null,
"default_branch": "master",
2017-08-17 22:00:37 +05:30
"visibility": "private",
2014-09-02 18:07:02 +05:30
"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",
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",
2015-04-26 12:48:37 +05:30
"tag_list": [
"example",
"disapora project"
],
2014-09-02 18:07:02 +05:30
"owner": {
"id": 3,
"name": "Diaspora",
2016-08-24 12:49:21 +05:30
"created_at": "2013-09-30T13:46:02Z"
2014-09-02 18:07:02 +05:30
},
"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,
2015-12-23 02:04:40 +05:30
"open_issues_count": 1,
2014-09-02 18:07:02 +05:30
"merge_requests_enabled": true,
2017-08-17 22:00:37 +05:30
"jobs_enabled": true,
2014-09-02 18:07:02 +05:30
"wiki_enabled": true,
"snippets_enabled": false,
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
2016-08-24 12:49:21 +05:30
"container_registry_enabled": false,
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2015-04-26 12:48:37 +05:30
"creator_id": 3,
2014-09-02 18:07:02 +05:30
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
2017-08-17 22:00:37 +05:30
"kind": "group",
"full_path": "diaspora"
2014-09-02 18:07:02 +05:30
},
2017-09-10 17:25:29 +05:30
"import_status": "none",
"import_error": null,
2014-09-02 18:07:02 +05:30
"permissions": {
"project_access": {
"access_level": 10,
"notification_level": 3
},
"group_access": {
"access_level": 50,
"notification_level": 3
}
},
2015-04-26 12:48:37 +05:30
"archived": false,
"avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
2018-12-13 13:39:08 +05:30
"license_url": "http://example.com/diaspora/diaspora-client/blob/master/LICENSE",
"license": {
"key": "lgpl-3.0",
"name": "GNU Lesser General Public License v3.0",
"nickname": "GNU LGPLv3",
"html_url": "http://choosealicense.com/licenses/lgpl-3.0/",
"source_url": "http://www.gnu.org/licenses/lgpl-3.0.txt"
},
"shared_runners_enabled": true,
"forks_count": 0,
"star_count": 0,
2016-08-24 12:49:21 +05:30
"runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
2017-08-17 22:00:37 +05:30
"public_jobs": true,
2016-08-24 12:49:21 +05:30
"shared_with_groups": [
{
"group_id": 4,
"group_name": "Twitter",
2019-03-02 22:35:43 +05:30
"group_full_path": "twitter",
2016-08-24 12:49:21 +05:30
"group_access_level": 30
},
{
"group_id": 3,
"group_name": "Gitlab Org",
2019-03-02 22:35:43 +05:30
"group_full_path": "gitlab-org",
2016-08-24 12:49:21 +05:30
"group_access_level": 10
}
2016-09-29 09:46:39 +05:30
],
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_pipeline_succeeds": false,
"only_allow_merge_if_all_discussions_are_resolved": false,
2017-09-10 17:25:29 +05:30
"printing_merge_requests_link_enabled": true,
2017-08-17 22:00:37 +05:30
"request_access_enabled": false,
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
2017-08-17 22:00:37 +05:30
"statistics": {
"commit_count": 37,
"storage_size": 1038090,
"repository_size": 1038090,
"lfs_objects_size": 0,
"job_artifacts_size": 0
2017-09-10 17:25:29 +05:30
},
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
"merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
"repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
"labels": "http://example.com/api/v4/projects/1/labels",
"events": "http://example.com/api/v4/projects/1/events",
"members": "http://example.com/api/v4/projects/1/members"
2017-08-17 22:00:37 +05:30
}
2014-09-02 18:07:02 +05:30
}
```
2018-11-08 19:23:39 +05:30
If the project is a fork, and you provide a valid token to authenticate, the
`forked_from_project` field will appear in the response.
```json
{
"id":3,
...
"forked_from_project":{
"id":13083,
"description":"GitLab Community Edition",
"name":"GitLab Community Edition",
"name_with_namespace":"GitLab.org / GitLab Community Edition",
"path":"gitlab-ce",
"path_with_namespace":"gitlab-org/gitlab-ce",
"created_at":"2013-09-26T06:02:36.000Z",
"default_branch":"master",
"tag_list":[],
"ssh_url_to_repo":"git@gitlab.com:gitlab-org/gitlab-ce.git",
"http_url_to_repo":"https://gitlab.com/gitlab-org/gitlab-ce.git",
"web_url":"https://gitlab.com/gitlab-org/gitlab-ce",
"avatar_url":"https://assets.gitlab-static.net/uploads/-/system/project/avatar/13083/logo-extra-whitespace.png",
2018-12-13 13:39:08 +05:30
"license_url": "https://gitlab.com/gitlab-org/gitlab-ce/blob/master/LICENSE",
"license": {
"key": "mit",
"name": "MIT License",
"nickname": null,
"html_url": "http://choosealicense.com/licenses/mit/",
"source_url": "https://opensource.org/licenses/MIT",
},
2018-11-08 19:23:39 +05:30
"star_count":3812,
"forks_count":3561,
2018-11-18 11:00:15 +05:30
"last_activity_at":"2018-01-02T11:40:26.570Z",
"namespace": {
"id": 72,
"name": "GitLab.org",
"path": "gitlab-org",
"kind": "group",
"full_path": "gitlab-org",
"parent_id": null
}
2018-11-08 19:23:39 +05:30
}
...
}
```
2017-08-17 22:00:37 +05:30
## Get project users
Get the users list of a project.
2018-03-17 18:26:18 +05:30
```
GET /projects/:id/users
```
2017-08-17 22:00:37 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `search` | string | no | Search for specific 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"
}
]
```
2018-03-17 18:26:18 +05:30
## Get project events
2014-09-02 18:07:02 +05:30
2018-03-17 18:26:18 +05:30
Please refer to the [Events API documentation](events.md#list-a-projects-visible-events).
2014-09-02 18:07:02 +05:30
2018-03-17 18:26:18 +05:30
## Create project
2014-09-02 18:07:02 +05:30
Creates a new project owned by the authenticated user.
```
POST /projects
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `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-11-03 12:29:30 +05:30
| `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-08-17 22:00:37 +05:30
| `jobs_enabled` | boolean | no | Enable jobs for this project |
2016-11-03 12:29:30 +05:30
| `wiki_enabled` | boolean | no | Enable wiki for this project |
| `snippets_enabled` | boolean | no | Enable snippets for this project |
2018-03-17 18:26:18 +05:30
| `resolve_outdated_diff_discussions` | boolean | no | Automatically resolve merge request diffs discussions on lines changed with a push |
2016-11-03 12:29:30 +05:30
| `container_registry_enabled` | boolean | no | Enable container registry for this project |
| `shared_runners_enabled` | boolean | no | Enable shared runners for this project |
2017-09-10 17:25:29 +05:30
| `visibility` | string | no | See [project visibility level](#project-visibility-level) |
2016-11-03 12:29:30 +05:30
| `import_url` | string | no | URL to import repository from |
2019-02-15 15:39:39 +05:30
| `public_builds` | boolean | no | If `true`, jobs can be viewed by non-project-members |
2017-08-17 22:00:37 +05:30
| `only_allow_merge_if_pipeline_succeeds` | boolean | no | Set whether merge requests can only be merged with successful jobs |
| `only_allow_merge_if_all_discussions_are_resolved` | boolean | no | Set whether merge requests can only be merged when all the discussions are resolved |
2018-05-09 12:01:36 +05:30
| `merge_method` | string | no | Set the merge method used |
2016-11-03 12:29:30 +05:30
| `lfs_enabled` | boolean | no | Enable LFS |
| `request_access_enabled` | boolean | no | Allow users to request member access |
2017-09-10 17:25:29 +05:30
| `tag_list` | array | no | The list of tags for a project; put array of tags, that should be finally assigned to a project |
| `avatar` | mixed | no | Image file for avatar of the project |
| `printing_merge_request_link_enabled` | boolean | no | Show link to create/view merge request when pushing from the command line |
| `ci_config_path` | string | no | The path to CI config file |
2018-12-05 23:21:45 +05:30
| `initialize_with_readme` | boolean | no | `false` by default |
2014-09-02 18:07:02 +05:30
2018-03-17 18:26:18 +05:30
## Create project for user
2014-09-02 18:07:02 +05:30
Creates a new project owned by the specified user. Available only for admins.
```
POST /projects/user/:user_id
```
2016-11-03 12:29:30 +05:30
| 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 |
2017-08-17 22:00:37 +05:30
| `default_branch` | string | no | `master` by default |
2016-11-03 12:29:30 +05:30
| `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-08-17 22:00:37 +05:30
| `jobs_enabled` | boolean | no | Enable jobs for this project |
2016-11-03 12:29:30 +05:30
| `wiki_enabled` | boolean | no | Enable wiki for this project |
| `snippets_enabled` | boolean | no | Enable snippets for this project |
2018-03-17 18:26:18 +05:30
| `resolve_outdated_diff_discussions` | boolean | no | Automatically resolve merge request diffs discussions on lines changed with a push |
2016-11-03 12:29:30 +05:30
| `container_registry_enabled` | boolean | no | Enable container registry for this project |
| `shared_runners_enabled` | boolean | no | Enable shared runners for this project |
2017-08-17 22:00:37 +05:30
| `visibility` | string | no | See [project visibility level](#project-visibility-level) |
2016-11-03 12:29:30 +05:30
| `import_url` | string | no | URL to import repository from |
2019-02-15 15:39:39 +05:30
| `public_builds` | boolean | no | If `true`, jobs can be viewed by non-project-members |
2017-08-17 22:00:37 +05:30
| `only_allow_merge_if_pipeline_succeeds` | boolean | no | Set whether merge requests can only be merged with successful jobs |
| `only_allow_merge_if_all_discussions_are_resolved` | boolean | no | Set whether merge requests can only be merged when all the discussions are resolved |
2018-05-09 12:01:36 +05:30
| `merge_method` | string | no | Set the merge method used |
2016-11-03 12:29:30 +05:30
| `lfs_enabled` | boolean | no | Enable LFS |
| `request_access_enabled` | boolean | no | Allow users to request member access |
2017-09-10 17:25:29 +05:30
| `tag_list` | array | no | The list of tags for a project; put array of tags, that should be finally assigned to a project |
| `avatar` | mixed | no | Image file for avatar of the project |
| `printing_merge_request_link_enabled` | boolean | no | Show link to create/view merge request when pushing from the command line |
| `ci_config_path` | string | no | The path to CI config file |
2014-09-02 18:07:02 +05:30
2018-03-17 18:26:18 +05:30
## Edit project
2015-04-26 12:48:37 +05:30
2017-08-17 22:00:37 +05:30
Updates an existing project.
2015-04-26 12:48:37 +05:30
```
PUT /projects/:id
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2018-11-20 20:47:30 +05:30
| `name` | string | no | The name of the project |
2016-11-03 12:29:30 +05:30
| `path` | string | no | Custom repository name for the project. By default generated based on name |
2017-08-17 22:00:37 +05:30
| `default_branch` | string | no | `master` by default |
2016-11-03 12:29:30 +05:30
| `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-08-17 22:00:37 +05:30
| `jobs_enabled` | boolean | no | Enable jobs for this project |
2016-11-03 12:29:30 +05:30
| `wiki_enabled` | boolean | no | Enable wiki for this project |
| `snippets_enabled` | boolean | no | Enable snippets for this project |
2018-03-17 18:26:18 +05:30
| `resolve_outdated_diff_discussions` | boolean | no | Automatically resolve merge request diffs discussions on lines changed with a push |
2016-11-03 12:29:30 +05:30
| `container_registry_enabled` | boolean | no | Enable container registry for this project |
| `shared_runners_enabled` | boolean | no | Enable shared runners for this project |
2017-08-17 22:00:37 +05:30
| `visibility` | string | no | See [project visibility level](#project-visibility-level) |
2016-11-03 12:29:30 +05:30
| `import_url` | string | no | URL to import repository from |
2019-02-15 15:39:39 +05:30
| `public_builds` | boolean | no | If `true`, jobs can be viewed by non-project-members |
2017-08-17 22:00:37 +05:30
| `only_allow_merge_if_pipeline_succeeds` | boolean | no | Set whether merge requests can only be merged with successful jobs |
| `only_allow_merge_if_all_discussions_are_resolved` | boolean | no | Set whether merge requests can only be merged when all the discussions are resolved |
2018-05-09 12:01:36 +05:30
| `merge_method` | string | no | Set the merge method used |
2016-11-03 12:29:30 +05:30
| `lfs_enabled` | boolean | no | Enable LFS |
| `request_access_enabled` | boolean | no | Allow users to request member access |
2017-09-10 17:25:29 +05:30
| `tag_list` | array | no | The list of tags for a project; put array of tags, that should be finally assigned to a project |
| `avatar` | mixed | no | Image file for avatar of the project |
| `ci_config_path` | string | no | The path to CI config file |
2015-04-26 12:48:37 +05:30
2018-03-17 18:26:18 +05:30
## Fork project
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
Forks a project into the user namespace of the authenticated user or the one provided.
2015-04-26 12:48:37 +05:30
2018-03-17 18:26:18 +05:30
The forking operation for a project is asynchronous and is completed in a
background job. The request will return immediately. To determine whether the
fork of the project has completed, query the `import_status` for the new project.
2017-09-10 17:25:29 +05:30
2015-04-26 12:48:37 +05:30
```
2017-08-17 22:00:37 +05:30
POST /projects/:id/fork
2015-04-26 12:48:37 +05:30
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2016-11-03 12:29:30 +05:30
| `namespace` | integer/string | yes | The ID or path of the namespace that the project will be forked to |
2015-04-26 12:48:37 +05:30
2018-03-17 18:26:18 +05:30
## List Forks of a project
>**Note:** This feature was introduced in GitLab 10.1
List the projects accessible to the calling user that have an established, forked relationship with the specified project
```
GET /projects/:id/forks
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
| `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 projects matching the search criteria |
2018-11-18 11:00:15 +05:30
| `simple` | boolean | no | Return only limited fields for each project. This is a no-op without authentication as then _only_ simple fields are returned. |
| `owned` | boolean | no | Limit by projects explicitly owned by the current user |
2018-03-17 18:26:18 +05:30
| `membership` | boolean | no | Limit by projects that the current user is a member of |
| `starred` | boolean | no | Limit by projects starred by the current user |
| `statistics` | boolean | no | Include project statistics |
2018-03-27 19:54:05 +05:30
| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) |
2018-03-17 18:26:18 +05:30
| `with_issues_enabled` | boolean | no | Limit by enabled issues feature |
| `with_merge_requests_enabled` | boolean | no | Limit by enabled merge requests feature |
2018-11-18 11:00:15 +05:30
| `min_access_level` | integer | no | Limit by current user minimal [access level](members.md) |
2018-03-17 18:26:18 +05:30
```bash
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/forks"
2018-03-17 18:26:18 +05:30
```
Example responses:
```json
[
{
"id": 3,
"description": null,
"default_branch": "master",
"visibility": "internal",
"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",
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",
2018-03-17 18:26:18 +05:30
"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,
"jobs_enabled": true,
"wiki_enabled": true,
"snippets_enabled": false,
"resolve_outdated_diff_discussions": false,
"container_registry_enabled": false,
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
"creator_id": 3,
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
"kind": "group",
"full_path": "diaspora"
},
"import_status": "none",
"archived": true,
"avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
"shared_runners_enabled": true,
"forks_count": 0,
"star_count": 1,
"public_jobs": true,
"shared_with_groups": [],
"only_allow_merge_if_pipeline_succeeds": false,
"only_allow_merge_if_all_discussions_are_resolved": false,
"request_access_enabled": false,
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
2018-03-17 18:26:18 +05:30
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
"merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
"repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
"labels": "http://example.com/api/v4/projects/1/labels",
"events": "http://example.com/api/v4/projects/1/events",
"members": "http://example.com/api/v4/projects/1/members"
}
}
]
```
## Star a project
2016-06-02 11:05:42 +05:30
2017-08-17 22:00:37 +05:30
Stars a given project. Returns status code `304` if the project is already starred.
2016-06-02 11:05:42 +05:30
```
POST /projects/:id/star
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2016-06-02 11:05:42 +05:30
```bash
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/star"
2016-06-02 11:05:42 +05:30
```
Example response:
```json
{
"id": 3,
"description": null,
"default_branch": "master",
2017-08-17 22:00:37 +05:30
"visibility": "internal",
2016-06-02 11:05:42 +05:30
"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",
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",
2016-06-02 11:05:42 +05:30
"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-08-17 22:00:37 +05:30
"jobs_enabled": true,
2016-06-02 11:05:42 +05:30
"wiki_enabled": true,
"snippets_enabled": false,
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
2016-08-24 12:49:21 +05:30
"container_registry_enabled": false,
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2016-06-02 11:05:42 +05:30
"creator_id": 3,
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
2017-08-17 22:00:37 +05:30
"kind": "group",
"full_path": "diaspora"
2016-06-02 11:05:42 +05:30
},
2017-09-10 17:25:29 +05:30
"import_status": "none",
2016-06-02 11:05:42 +05:30
"archived": true,
"avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
2018-12-13 13:39:08 +05:30
"license_url": "http://example.com/diaspora/diaspora-client/blob/master/LICENSE",
"license": {
"key": "lgpl-3.0",
"name": "GNU Lesser General Public License v3.0",
"nickname": "GNU LGPLv3",
"html_url": "http://choosealicense.com/licenses/lgpl-3.0/",
"source_url": "http://www.gnu.org/licenses/lgpl-3.0.txt"
},
2016-06-02 11:05:42 +05:30
"shared_runners_enabled": true,
"forks_count": 0,
2016-08-24 12:49:21 +05:30
"star_count": 1,
2017-08-17 22:00:37 +05:30
"public_jobs": true,
2016-09-29 09:46:39 +05:30
"shared_with_groups": [],
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_pipeline_succeeds": false,
"only_allow_merge_if_all_discussions_are_resolved": false,
2017-09-10 17:25:29 +05:30
"request_access_enabled": false,
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
2017-09-10 17:25:29 +05:30
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
"merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
"repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
"labels": "http://example.com/api/v4/projects/1/labels",
"events": "http://example.com/api/v4/projects/1/events",
"members": "http://example.com/api/v4/projects/1/members"
}
2016-06-02 11:05:42 +05:30
}
```
2018-03-17 18:26:18 +05:30
## Unstar a project
2016-06-02 11:05:42 +05:30
2017-08-17 22:00:37 +05:30
Unstars a given project. Returns status code `304` if the project is not starred.
2016-06-02 11:05:42 +05:30
```
2017-08-17 22:00:37 +05:30
POST /projects/:id/unstar
2016-06-02 11:05:42 +05:30
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2016-06-02 11:05:42 +05:30
```bash
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/unstar"
2016-06-02 11:05:42 +05:30
```
Example response:
```json
{
"id": 3,
"description": null,
"default_branch": "master",
2017-08-17 22:00:37 +05:30
"visibility": "internal",
2016-06-02 11:05:42 +05:30
"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",
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",
2016-06-02 11:05:42 +05:30
"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-08-17 22:00:37 +05:30
"jobs_enabled": true,
2016-06-02 11:05:42 +05:30
"wiki_enabled": true,
"snippets_enabled": false,
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
2016-08-24 12:49:21 +05:30
"container_registry_enabled": false,
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2016-06-02 11:05:42 +05:30
"creator_id": 3,
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
2017-08-17 22:00:37 +05:30
"kind": "group",
"full_path": "diaspora"
2016-06-02 11:05:42 +05:30
},
2017-09-10 17:25:29 +05:30
"import_status": "none",
2016-06-02 11:05:42 +05:30
"archived": true,
"avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
2018-12-13 13:39:08 +05:30
"license_url": "http://example.com/diaspora/diaspora-client/blob/master/LICENSE",
"license": {
"key": "lgpl-3.0",
"name": "GNU Lesser General Public License v3.0",
"nickname": "GNU LGPLv3",
"html_url": "http://choosealicense.com/licenses/lgpl-3.0/",
"source_url": "http://www.gnu.org/licenses/lgpl-3.0.txt"
},
2016-06-02 11:05:42 +05:30
"shared_runners_enabled": true,
"forks_count": 0,
2016-08-24 12:49:21 +05:30
"star_count": 0,
2017-08-17 22:00:37 +05:30
"public_jobs": true,
2016-09-29 09:46:39 +05:30
"shared_with_groups": [],
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_pipeline_succeeds": false,
"only_allow_merge_if_all_discussions_are_resolved": false,
2017-09-10 17:25:29 +05:30
"request_access_enabled": false,
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
2017-09-10 17:25:29 +05:30
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
"merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
"repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
"labels": "http://example.com/api/v4/projects/1/labels",
"events": "http://example.com/api/v4/projects/1/events",
"members": "http://example.com/api/v4/projects/1/members"
}
2016-06-02 11:05:42 +05:30
}
```
2018-10-15 14:42:47 +05:30
## Languages
Get languages used in a project with percentage value.
```
GET /projects/:id/languages
```
```bash
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/languages"
2018-10-15 14:42:47 +05:30
```
Example response:
```json
{
"Ruby": 66.69,
"JavaScript": 22.98,
"HTML": 7.91,
"CoffeeScript": 2.42
}
```
2018-03-17 18:26:18 +05:30
## Archive a project
2016-06-02 11:05:42 +05:30
Archives the project if the user is either admin or the project owner of this project. This action is
idempotent, thus archiving an already archived project will not change the project.
```
POST /projects/:id/archive
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2016-06-02 11:05:42 +05:30
```bash
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/archive"
2016-06-02 11:05:42 +05:30
```
Example response:
```json
{
"id": 3,
"description": null,
"default_branch": "master",
2017-08-17 22:00:37 +05:30
"visibility": "private",
2016-06-02 11:05:42 +05:30
"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",
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",
2016-06-02 11:05:42 +05:30
"tag_list": [
"example",
"disapora project"
],
"owner": {
"id": 3,
"name": "Diaspora",
2016-08-24 12:49:21 +05:30
"created_at": "2013-09-30T13:46:02Z"
2016-06-02 11:05:42 +05:30
},
"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-08-17 22:00:37 +05:30
"jobs_enabled": true,
2016-06-02 11:05:42 +05:30
"wiki_enabled": true,
"snippets_enabled": false,
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
2016-08-24 12:49:21 +05:30
"container_registry_enabled": false,
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2016-06-02 11:05:42 +05:30
"creator_id": 3,
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
2017-08-17 22:00:37 +05:30
"kind": "group",
"full_path": "diaspora"
2016-06-02 11:05:42 +05:30
},
2017-09-10 17:25:29 +05:30
"import_status": "none",
"import_error": null,
2016-06-02 11:05:42 +05:30
"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",
2018-12-13 13:39:08 +05:30
"license_url": "http://example.com/diaspora/diaspora-client/blob/master/LICENSE",
"license": {
"key": "lgpl-3.0",
"name": "GNU Lesser General Public License v3.0",
"nickname": "GNU LGPLv3",
"html_url": "http://choosealicense.com/licenses/lgpl-3.0/",
"source_url": "http://www.gnu.org/licenses/lgpl-3.0.txt"
},
2016-06-02 11:05:42 +05:30
"shared_runners_enabled": true,
"forks_count": 0,
"star_count": 0,
2016-08-24 12:49:21 +05:30
"runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
2017-08-17 22:00:37 +05:30
"public_jobs": true,
2016-09-29 09:46:39 +05:30
"shared_with_groups": [],
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_pipeline_succeeds": false,
"only_allow_merge_if_all_discussions_are_resolved": false,
2017-09-10 17:25:29 +05:30
"request_access_enabled": false,
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
2017-09-10 17:25:29 +05:30
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
"merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
"repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
"labels": "http://example.com/api/v4/projects/1/labels",
"events": "http://example.com/api/v4/projects/1/events",
"members": "http://example.com/api/v4/projects/1/members"
}
2016-06-02 11:05:42 +05:30
}
```
2018-03-17 18:26:18 +05:30
## Unarchive a project
2016-06-02 11:05:42 +05:30
Unarchives the project if the user is either admin or the project owner of this project. This action is
2018-03-17 18:26:18 +05:30
idempotent, thus unarchiving a non-archived project will not change the project.
2016-06-02 11:05:42 +05:30
```
2016-08-24 12:49:21 +05:30
POST /projects/:id/unarchive
2016-06-02 11:05:42 +05:30
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2016-06-02 11:05:42 +05:30
```bash
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/unarchive"
2016-06-02 11:05:42 +05:30
```
Example response:
```json
{
"id": 3,
"description": null,
"default_branch": "master",
2017-08-17 22:00:37 +05:30
"visibility": "private",
2016-06-02 11:05:42 +05:30
"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",
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",
2016-06-02 11:05:42 +05:30
"tag_list": [
"example",
"disapora project"
],
"owner": {
"id": 3,
"name": "Diaspora",
2016-08-24 12:49:21 +05:30
"created_at": "2013-09-30T13:46:02Z"
2016-06-02 11:05:42 +05:30
},
"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-08-17 22:00:37 +05:30
"jobs_enabled": true,
2016-06-02 11:05:42 +05:30
"wiki_enabled": true,
"snippets_enabled": false,
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
2016-08-24 12:49:21 +05:30
"container_registry_enabled": false,
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2016-06-02 11:05:42 +05:30
"creator_id": 3,
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
2017-08-17 22:00:37 +05:30
"kind": "group",
"full_path": "diaspora"
2016-06-02 11:05:42 +05:30
},
2017-09-10 17:25:29 +05:30
"import_status": "none",
"import_error": null,
2016-06-02 11:05:42 +05:30
"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",
2018-12-13 13:39:08 +05:30
"license_url": "http://example.com/diaspora/diaspora-client/blob/master/LICENSE",
"license": {
"key": "lgpl-3.0",
"name": "GNU Lesser General Public License v3.0",
"nickname": "GNU LGPLv3",
"html_url": "http://choosealicense.com/licenses/lgpl-3.0/",
"source_url": "http://www.gnu.org/licenses/lgpl-3.0.txt"
},
2016-06-02 11:05:42 +05:30
"shared_runners_enabled": true,
"forks_count": 0,
"star_count": 0,
2016-08-24 12:49:21 +05:30
"runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
2017-08-17 22:00:37 +05:30
"public_jobs": true,
2016-09-29 09:46:39 +05:30
"shared_with_groups": [],
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_pipeline_succeeds": false,
"only_allow_merge_if_all_discussions_are_resolved": false,
2017-09-10 17:25:29 +05:30
"request_access_enabled": false,
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
2017-09-10 17:25:29 +05:30
"_links": {
"self": "http://example.com/api/v4/projects",
"issues": "http://example.com/api/v4/projects/1/issues",
"merge_requests": "http://example.com/api/v4/projects/1/merge_requests",
"repo_branches": "http://example.com/api/v4/projects/1/repository_branches",
"labels": "http://example.com/api/v4/projects/1/labels",
"events": "http://example.com/api/v4/projects/1/events",
"members": "http://example.com/api/v4/projects/1/members"
}
2016-06-02 11:05:42 +05:30
}
```
2018-03-17 18:26:18 +05:30
## Remove project
2014-09-02 18:07:02 +05:30
Removes a project including all associated resources (issues, merge requests etc.)
```
DELETE /projects/:id
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2014-09-02 18:07:02 +05:30
2018-03-17 18:26:18 +05:30
## 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
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2016-11-03 12:29:30 +05:30
| `file` | string | yes | The file to be uploaded |
2017-08-17 22:00:37 +05:30
To upload a file from your filesystem, use the `--form` argument. This causes
cURL to post data using the header `Content-Type: multipart/form-data`.
The `file=` parameter must point to a file on your filesystem and be preceded
by `@`. For example:
```bash
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "file=@dk.png" https://gitlab.example.com/api/v4/projects/5/uploads
2017-08-17 22:00:37 +05:30
```
Returned object:
```json
{
"alt": "dk",
"url": "/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png",
"markdown": "![dk](/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png)"
}
```
2018-03-17 18:26:18 +05:30
>**Note**: The returned `url` is relative to the project path.
2017-08-17 22:00:37 +05:30
In Markdown contexts, the link is automatically expanded when the format in
`markdown` is used.
2018-03-17 18:26:18 +05:30
## Share project with group
2016-06-02 11:05:42 +05:30
Allow to share project with group.
```
POST /projects/:id/share
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2016-11-03 12:29:30 +05:30
| `group_id` | integer | yes | The ID of the group to share with |
2018-11-08 19:23:39 +05:30
| `group_access` | integer | yes | The [permissions level](members.md) to grant the group |
2016-11-03 12:29:30 +05:30
| `expires_at` | string | no | Share expiration date in ISO 8601 format: 2016-09-26 |
2016-06-02 11:05:42 +05:30
2018-03-17 18:26:18 +05:30
## Delete a shared project link within a group
2017-08-17 22:00:37 +05:30
Unshare the project from the group. Returns `204` and no content on success.
```
DELETE /projects/:id/share/:group_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
| `group_id` | integer | yes | The ID of the group |
```bash
2019-02-15 15:39:39 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/share/17
2017-08-17 22:00:37 +05:30
```
2014-09-02 18:07:02 +05:30
## Hooks
2015-09-11 14:41:01 +05:30
Also called Project Hooks and Webhooks.
These are different for [System Hooks](system_hooks.md) that are system wide.
2014-09-02 18:07:02 +05:30
### List project hooks
Get a list of project hooks.
```
GET /projects/:id/hooks
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2014-09-02 18:07:02 +05:30
### Get project hook
Get a specific hook for a project.
```
GET /projects/:id/hooks/:hook_id
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2016-11-03 12:29:30 +05:30
| `hook_id` | integer | yes | The ID of a project hook |
2014-09-02 18:07:02 +05:30
```json
{
"id": 1,
"url": "http://example.com/hook",
"project_id": 3,
2016-08-24 12:49:21 +05:30
"push_events": true,
2018-11-20 20:47:30 +05:30
"push_events_branch_filter": "",
2016-08-24 12:49:21 +05:30
"issues_events": true,
2018-03-27 19:54:05 +05:30
"confidential_issues_events": true,
2016-08-24 12:49:21 +05:30
"merge_requests_events": true,
2016-09-29 09:46:39 +05:30
"tag_push_events": true,
2016-08-24 12:49:21 +05:30
"note_events": true,
2017-08-17 22:00:37 +05:30
"job_events": true,
2016-09-29 09:46:39 +05:30
"pipeline_events": true,
"wiki_page_events": true,
2016-08-24 12:49:21 +05:30
"enable_ssl_verification": true,
2014-09-02 18:07:02 +05:30
"created_at": "2012-10-12T17:04:47Z"
}
```
### Add project hook
Adds a hook to a specified project.
```
POST /projects/:id/hooks
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2016-11-03 12:29:30 +05:30
| `url` | string | yes | The hook URL |
| `push_events` | boolean | no | Trigger hook on push events |
2018-11-20 20:47:30 +05:30
| `push_events_branch_filter` | string | no | Trigger hook on push events for matching branches only |
2016-11-03 12:29:30 +05:30
| `issues_events` | boolean | no | Trigger hook on issues events |
2018-03-27 19:54:05 +05:30
| `confidential_issues_events` | boolean | no | Trigger hook on confidential issues events |
2016-11-03 12:29:30 +05:30
| `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-08-17 22:00:37 +05:30
| `job_events` | boolean | no | Trigger hook on job events |
2016-11-03 12:29:30 +05:30
| `pipeline_events` | boolean | no | Trigger hook on pipeline events |
2018-03-27 19:54:05 +05:30
| `wiki_page_events` | boolean | no | Trigger hook on wiki events |
2016-11-03 12:29:30 +05:30
| `enable_ssl_verification` | boolean | no | Do SSL verification when triggering the hook |
2017-08-17 22:00:37 +05:30
| `token` | string | no | Secret token to validate received payloads; this will not be returned in the response |
2014-09-02 18:07:02 +05:30
### Edit project hook
Edits a hook for a specified project.
```
PUT /projects/:id/hooks/:hook_id
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2016-11-03 12:29:30 +05:30
| `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 |
2018-11-20 20:47:30 +05:30
| `push_events_branch_filter` | string | no | Trigger hook on push events for matching branches only |
2016-11-03 12:29:30 +05:30
| `issues_events` | boolean | no | Trigger hook on issues events |
2018-03-27 19:54:05 +05:30
| `confidential_issues_events` | boolean | no | Trigger hook on confidential issues events |
2016-11-03 12:29:30 +05:30
| `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-08-17 22:00:37 +05:30
| `job_events` | boolean | no | Trigger hook on job events |
2016-11-03 12:29:30 +05:30
| `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 |
2017-08-17 22:00:37 +05:30
| `token` | string | no | Secret token to validate received payloads; this will not be returned in the response |
2014-09-02 18:07:02 +05:30
### Delete project hook
Removes a hook from a project. This is an idempotent method and can be called multiple times.
Either the hook is available or not.
```
DELETE /projects/:id/hooks/:hook_id
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2016-11-03 12:29:30 +05:30
| `hook_id` | integer | yes | The ID of the project hook |
2014-09-02 18:07:02 +05:30
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.
2018-11-20 20:47:30 +05:30
## Fork relationship
2014-09-02 18:07:02 +05:30
2018-11-20 20:47:30 +05:30
Allows modification of the forked relationship between existing projects. Available only for project owners and admins.
2014-09-02 18:07:02 +05:30
2018-03-17 18:26:18 +05:30
### Create a forked from/to relation between existing projects
2014-09-02 18:07:02 +05:30
2018-11-20 20:47:30 +05:30
CAUTION: **Warning:**
This will destroy the LFS objects stored in the fork.
So to retain the LFS objects, make sure you've pulled them **before** creating the fork relation,
and push them again **after** creating the fork relation.
2014-09-02 18:07:02 +05:30
```
POST /projects/:id/fork/:forked_from_id
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2016-11-03 12:29:30 +05:30
| `forked_from_id` | ID | yes | The ID of the project that was forked from |
2014-09-02 18:07:02 +05:30
### Delete an existing forked from relationship
```
DELETE /projects/:id/fork
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-08-17 22:00:37 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2014-09-02 18:07:02 +05:30
## Search for projects by name
2017-08-17 22:00:37 +05:30
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.
2014-09-02 18:07:02 +05:30
```
2017-09-10 17:25:29 +05:30
GET /projects
2014-09-02 18:07:02 +05:30
```
2016-11-03 12:29:30 +05:30
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-09-10 17:25:29 +05:30
| `search` | string | yes | A string contained in the project name |
2016-11-03 12:29:30 +05:30
| `order_by` | string | no | Return requests ordered by `id`, `name`, `created_at` or `last_activity_at` fields |
| `sort` | string | no | Return requests sorted in `asc` or `desc` order |
2017-08-17 22:00:37 +05:30
2017-09-10 17:25:29 +05:30
```bash
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects?search=test
2017-09-10 17:25:29 +05:30
```
2017-08-17 22:00:37 +05:30
## Start the Housekeeping task for a Project
2018-03-17 18:26:18 +05:30
> Introduced in GitLab 9.0.
2017-08-17 22:00:37 +05:30
```
POST /projects/:id/housekeeping
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2018-03-17 18:26:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
2018-11-08 19:23:39 +05:30
### Transfer a project to a new namespace
```
PUT /projects/:id/transfer
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `namespace` | integer/string | yes | The ID or path of the namespace to transfer to project to |
2018-03-17 18:26:18 +05:30
## Branches
Read more in the [Branches](branches.md) documentation.
2018-03-27 19:54:05 +05:30
## Project Import/Export
Read more in the [Project import/export](project_import_export.md) documentation.
2018-03-17 18:26:18 +05:30
## Project members
Read more in the [Project members](members.md) documentation.
2018-03-27 19:54:05 +05:30
## Project badges
Read more in the [Project Badges](project_badges.md) documentation.
2018-05-09 12:01:36 +05:30
## Issue and merge request description templates
The non-default [issue and merge request description templates](../user/project/description_templates.md) are managed inside the project's repository. So you can manage them via the API through the [Repositories API](repositories.md) and the [Repository Files API](repository_files.md).
## Download snapshot of a git repository
> Introduced in GitLab 10.7
This endpoint may only be accessed by an administrative user.
Download a snapshot of the project (or wiki, if requested) git repository. This
snapshot is always in uncompressed [tar](https://en.wikipedia.org/wiki/Tar_(computing))
format.
If a repository is corrupted to the point where `git clone` does not work, the
snapshot may allow some of the data to be retrieved.
```
GET /projects/:id/snapshot
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
| `wiki` | boolean | no | Whether to download the wiki, rather than project, repository |
2018-11-18 11:00:15 +05:30
[eep]: https://about.gitlab.com/pricing/ "Available only in GitLab Premium"
[ee-6137]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6137