realaravinth/debian-mirror-gitlab
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
debian-mirror-gitlab/doc/api/projects.md

2467 lines
117 KiB
Markdown
Raw Normal View History

New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
---
stage: Plan
group: Project Management
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
---
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
# Projects API
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Project visibility level
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
New upstream version 9.5.4+dfsg
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.
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
Values for the project visibility level are:
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
- `private`: project access must be granted explicitly for each user.
- `internal`: the project can be cloned by any signed-in user except [external users](../user/permissions.md#external-users).
- `public`: the project can be accessed without any authentication.
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
## Project merge method
New upstream version 13.4.6
2020-11-24 15:15:51 +05:30
There are three options for `merge_method` to choose from:
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
- `merge`: a merge commit is created for every merge, and merging is allowed if
there are no conflicts.
- `rebase_merge`: 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.
- `ff`: 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.
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## List all projects
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
Get a list of all visible projects across GitLab for the authenticated user.
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
When accessed without authentication, only public projects with _simple_ fields
are returned.
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
GET /projects
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|--------------------------------------------|----------|------------------------|-------------|
| `archived` | boolean | **{dotted-circle}** No | Limit by archived status. |
| `id_after` | integer | **{dotted-circle}** No | Limit results to projects with IDs greater than the specified ID. |
| `id_before` | integer | **{dotted-circle}** No | Limit results to projects with IDs less than the specified ID. |
| `last_activity_after` | datetime | **{dotted-circle}** No | Limit results to projects with last_activity after specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ |
| `last_activity_before` | datetime | **{dotted-circle}** No | Limit results to projects with last_activity before specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ |
| `membership` | boolean | **{dotted-circle}** No | Limit by projects that the current user is a member of. |
| `min_access_level` | integer | **{dotted-circle}** No | Limit by current user minimal [access level](members.md#valid-access-levels). |
| `order_by` | string | **{dotted-circle}** No | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. `repository_size`, `storage_size`, or `wiki_size` fields are only allowed for admins. Default is `created_at`. |
| `owned` | boolean | **{dotted-circle}** No | Limit by projects explicitly owned by the current user. |
| `repository_checksum_failed` **(PREMIUM)** | boolean | **{dotted-circle}** No | Limit projects where the repository checksum calculation has failed ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2). |
| `repository_storage` | string | **{dotted-circle}** No | Limit results to projects stored on `repository_storage`. _(admins only)_ |
| `search_namespaces` | boolean | **{dotted-circle}** No | Include ancestor namespaces when matching search criteria. Default is `false`. |
| `search` | string | **{dotted-circle}** No | Return list of projects matching the search criteria. |
| `simple` | boolean | **{dotted-circle}** No | Return only limited fields for each project. This is a no-op without authentication as then _only_ simple fields are returned. |
| `sort` | string | **{dotted-circle}** No | Return projects sorted in `asc` or `desc` order. Default is `desc`. |
| `starred` | boolean | **{dotted-circle}** No | Limit by projects starred by the current user. |
| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. |
| `visibility` | string | **{dotted-circle}** No | Limit by visibility `public`, `internal`, or `private`. |
| `wiki_checksum_failed` **(PREMIUM)** | boolean | **{dotted-circle}** No | Limit projects where the wiki checksum calculation has failed ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2). |
| `with_custom_attributes` | boolean | **{dotted-circle}** No | Include [custom attributes](custom_attributes.md) in response. _(admins only)_ |
| `with_issues_enabled` | boolean | **{dotted-circle}** No | Limit by enabled issues feature. |
| `with_merge_requests_enabled` | boolean | **{dotted-circle}** No | Limit by enabled merge requests feature. |
| `with_programming_language` | string | **{dotted-circle}** No | Limit by projects which use the given programming language. |
This endpoint supports [keyset pagination](README.md#keyset-based-pagination)
for selected `order_by` options.
New upstream version 12.6.1
2020-01-01 13:55:28 +05:30
New upstream version 11.2.8+dfsg
2018-11-18 11:00:15 +05:30
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:
New upstream version 9.5.4+dfsg
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",
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-client/blob/master/README.md",
New upstream version 9.5.4+dfsg
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,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"can_create_merge_request_in": true,
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
New upstream version 9.5.4+dfsg
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",
New upstream version 12.0.8
2019-09-04 21:01:54 +05:30
"ci_default_git_depth": 50,
New upstream version 13.5.5
2021-01-03 14:25:43 +05:30
"ci_forward_deployment_enabled": true,
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"public_jobs": true,
"shared_with_groups": [],
"only_allow_merge_if_pipeline_succeeds": false,
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
"allow_merge_on_skipped_pipeline": false,
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"only_allow_merge_if_all_discussions_are_resolved": false,
New upstream version 12.5.4
2019-12-26 22:10:19 +05:30
"remove_source_branch_after_merge": false,
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"request_access_enabled": false,
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"autoclose_referenced_issues": true,
"suggestion_commit_message": null,
New upstream version 13.0.0
2020-05-24 23:13:21 +05:30
"marked_for_deletion_at": "2020-04-03", // Deprecated and will be removed in API v5 in favor of marked_for_deletion_on
New upstream version 12.10.0
2020-04-22 19:07:51 +05:30
"marked_for_deletion_on": "2020-04-03",
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"statistics": {
"commit_count": 37,
"storage_size": 1038090,
"repository_size": 1038090,
New upstream version 12.0.8
2019-09-04 21:01:54 +05:30
"wiki_size" : 0,
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"lfs_objects_size": 0,
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
"job_artifacts_size": 0,
New upstream version 13.2.1
2020-07-28 23:09:34 +05:30
"packages_size": 0,
"snippets_size": 0
New upstream version 9.5.4+dfsg
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"
},
},
{
"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",
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/brightbox/puppet/blob/master/README.md",
New upstream version 9.5.4+dfsg
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,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"can_create_merge_request_in": true,
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
New upstream version 9.5.4+dfsg
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",
New upstream version 12.0.8
2019-09-04 21:01:54 +05:30
"ci_default_git_depth": 0,
New upstream version 13.5.5
2021-01-03 14:25:43 +05:30
"ci_forward_deployment_enabled": true,
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"public_jobs": true,
"shared_with_groups": [],
"only_allow_merge_if_pipeline_succeeds": false,
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
"allow_merge_on_skipped_pipeline": false,
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"only_allow_merge_if_all_discussions_are_resolved": false,
New upstream version 12.5.4
2019-12-26 22:10:19 +05:30
"remove_source_branch_after_merge": false,
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"request_access_enabled": false,
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
New upstream version 12.6.1
2020-01-01 13:55:28 +05:30
"auto_devops_enabled": true,
"auto_devops_deploy_strategy": "continuous",
"repository_storage": "default",
"approvals_before_merge": 0,
"mirror": false,
"mirror_user_id": 45,
"mirror_trigger_builds": false,
"only_mirror_protected_branches": false,
"mirror_overwrites_diverged_branches": false,
"external_authorization_classification_label": null,
"packages_enabled": true,
"service_desk_enabled": false,
"service_desk_address": null,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"autoclose_referenced_issues": true,
"suggestion_commit_message": null,
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"statistics": {
"commit_count": 12,
"storage_size": 2066080,
"repository_size": 2066080,
New upstream version 12.0.8
2019-09-04 21:01:54 +05:30
"wiki_size" : 0,
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"lfs_objects_size": 0,
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
"job_artifacts_size": 0,
New upstream version 13.2.1
2020-07-28 23:09:34 +05:30
"packages_size": 0,
"snippets_size": 0
New upstream version 9.5.4+dfsg
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"
}
}
]
```
New upstream version 12.10.0
2020-04-22 19:07:51 +05:30
NOTE: **Note:**
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
For users of GitLab [Silver, Premium, or higher](https://about.gitlab.com/pricing/),
the `marked_for_deletion_at` attribute has been deprecated, and will be removed
in API v5 in favor of the `marked_for_deletion_on` attribute.
New upstream version 12.10.0
2020-04-22 19:07:51 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Users of GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
can also see the `approvals_before_merge` parameter:
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
```json
[
{
"id": 4,
"description": null,
"approvals_before_merge": 0,
...
}
]
```
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
You can filter by [custom attributes](custom_attributes.md) with:
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
GET /projects?custom_attributes[key]=value&custom_attributes[other_key]=other_value
```
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
### Pagination limits
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
In GitLab 13.0 and later, [offset-based pagination](README.md#offset-based-pagination)
is [limited to 50,000 records](https://gitlab.com/gitlab-org/gitlab/-/issues/34565).
[Keyset pagination](README.md#keyset-based-pagination) is required to retrieve
projects beyond this limit.
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Keyset pagination supports only `order_by=id`. Other sorting options aren't available.
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## List user projects
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Get a list of visible projects owned by the given user. When accessed without
authentication, only public projects are returned.
This endpoint supports [keyset pagination](README.md#keyset-based-pagination)
for selected `order_by` options.
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
GET /users/:user_id/projects
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-------------------------------|---------|------------------------|-------------|
| `archived` | boolean | **{dotted-circle}** No | Limit by archived status. |
| `id_after` | integer | **{dotted-circle}** No | Limit results to projects with IDs greater than the specified ID. |
| `id_before` | integer | **{dotted-circle}** No | Limit results to projects with IDs less than the specified ID. |
| `membership` | boolean | **{dotted-circle}** No | Limit by projects that the current user is a member of. |
| `min_access_level` | integer | **{dotted-circle}** No | Limit by current user minimal [access level](members.md#valid-access-levels). |
| `order_by` | string | **{dotted-circle}** No | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at`. |
| `owned` | boolean | **{dotted-circle}** No | Limit by projects explicitly owned by the current user. |
| `search` | string | **{dotted-circle}** No | Return list of projects matching the search criteria. |
| `simple` | boolean | **{dotted-circle}** No | Return only limited fields for each project. This is a no-op without authentication as then _only_ simple fields are returned. |
| `sort` | string | **{dotted-circle}** No | Return projects sorted in `asc` or `desc` order. Default is `desc`. |
| `starred` | boolean | **{dotted-circle}** No | Limit by projects starred by the current user. |
| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. |
| `user_id` | string | **{check-circle}** Yes | The ID or username of the user. |
| `visibility` | string | **{dotted-circle}** No | Limit by visibility `public`, `internal`, or `private`. |
| `with_custom_attributes` | boolean | **{dotted-circle}** No | Include [custom attributes](custom_attributes.md) in response. _(admins only)_ |
| `with_issues_enabled` | boolean | **{dotted-circle}** No | Limit by enabled issues feature. |
| `with_merge_requests_enabled` | boolean | **{dotted-circle}** No | Limit by enabled merge requests feature. |
| `with_programming_language` | string | **{dotted-circle}** No | Limit by projects which use the given programming language. |
New upstream version 12.6.1
2020-01-01 13:55:28 +05:30
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
```json
[
{
"id": 4,
"description": null,
"default_branch": "master",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"visibility": "private",
Imported Upstream version 7.2.1
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",
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-client/blob/master/README.md",
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
"tag_list": [
"example",
"disapora client"
],
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
"owner": {
"id": 3,
"name": "Diaspora",
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"created_at": "2013-09-30T13:46:02Z"
Imported Upstream version 7.2.1
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,
Imported Upstream version 8.3.0+dfsg
2015-12-23 02:04:40 +05:30
"open_issues_count": 1,
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
"merge_requests_enabled": true,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"jobs_enabled": true,
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
"wiki_enabled": true,
"snippets_enabled": false,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"can_create_merge_request_in": true,
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
Imported Upstream version 8.10.5+dfsg
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",
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
"creator_id": 3,
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"kind": "group",
"full_path": "diaspora"
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
},
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"import_status": "none",
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
"archived": false,
Imported Upstream version 8.4.0+dfsg~rc2
2016-01-19 16:12:03 +05:30
"avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png",
"shared_runners_enabled": true,
"forks_count": 0,
Imported Upstream version 8.5.8+dfsg
2016-04-02 18:10:28 +05:30
"star_count": 0,
"runners_token": "b8547b1dc37721d05889db52fa2f02",
New upstream version 12.0.8
2019-09-04 21:01:54 +05:30
"ci_default_git_depth": 50,
New upstream version 13.5.5
2021-01-03 14:25:43 +05:30
"ci_forward_deployment_enabled": true,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"public_jobs": true,
New upstream version 8.12.1+dfsg1
2016-09-29 09:46:39 +05:30
"shared_with_groups": [],
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_pipeline_succeeds": false,
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
"allow_merge_on_skipped_pipeline": false,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_all_discussions_are_resolved": false,
New upstream version 12.5.4
2019-12-26 22:10:19 +05:30
"remove_source_branch_after_merge": false,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"request_access_enabled": false,
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"autoclose_referenced_issues": true,
"suggestion_commit_message": null,
New upstream version 13.0.0
2020-05-24 23:13:21 +05:30
"marked_for_deletion_at": "2020-04-03", // Deprecated and will be removed in API v5 in favor of marked_for_deletion_on
New upstream version 12.10.0
2020-04-22 19:07:51 +05:30
"marked_for_deletion_on": "2020-04-03",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"statistics": {
"commit_count": 37,
"storage_size": 1038090,
"repository_size": 1038090,
New upstream version 12.0.8
2019-09-04 21:01:54 +05:30
"wiki_size" : 0,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"lfs_objects_size": 0,
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
"job_artifacts_size": 0,
New upstream version 13.2.1
2020-07-28 23:09:34 +05:30
"packages_size": 0,
"snippets_size": 0
New upstream version 9.5.4+dfsg
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"
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
}
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
},
{
"id": 6,
"description": null,
"default_branch": "master",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"visibility": "private",
Imported Upstream version 7.2.1
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",
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/brightbox/puppet/blob/master/README.md",
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
"tag_list": [
"example",
"puppet"
],
Imported Upstream version 7.2.1
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,
Imported Upstream version 8.3.0+dfsg
2015-12-23 02:04:40 +05:30
"open_issues_count": 1,
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
"merge_requests_enabled": true,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"jobs_enabled": true,
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
"wiki_enabled": true,
"snippets_enabled": false,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"can_create_merge_request_in": true,
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"container_registry_enabled": false,
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
"creator_id": 3,
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
"namespace": {
"id": 4,
"name": "Brightbox",
"path": "brightbox",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"kind": "group",
"full_path": "brightbox"
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
},
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"import_status": "none",
"import_error": null,
Imported Upstream version 8.4.0+dfsg~rc1
2016-01-14 18:37:52 +05:30
"permissions": {
"project_access": {
"access_level": 10,
"notification_level": 3
},
"group_access": {
"access_level": 50,
"notification_level": 3
}
},
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
"archived": false,
Imported Upstream version 8.4.0+dfsg~rc2
2016-01-19 16:12:03 +05:30
"avatar_url": null,
"shared_runners_enabled": true,
"forks_count": 0,
"star_count": 0,
Imported Upstream version 8.5.8+dfsg
2016-04-02 18:10:28 +05:30
"runners_token": "b8547b1dc37721d05889db52fa2f02",
New upstream version 12.0.8
2019-09-04 21:01:54 +05:30
"ci_default_git_depth": 0,
New upstream version 13.5.5
2021-01-03 14:25:43 +05:30
"ci_forward_deployment_enabled": true,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"public_jobs": true,
New upstream version 8.12.1+dfsg1
2016-09-29 09:46:39 +05:30
"shared_with_groups": [],
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_pipeline_succeeds": false,
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
"allow_merge_on_skipped_pipeline": false,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_all_discussions_are_resolved": false,
New upstream version 12.5.4
2019-12-26 22:10:19 +05:30
"remove_source_branch_after_merge": false,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"request_access_enabled": false,
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
New upstream version 12.6.1
2020-01-01 13:55:28 +05:30
"auto_devops_enabled": true,
"auto_devops_deploy_strategy": "continuous",
"repository_storage": "default",
"approvals_before_merge": 0,
"mirror": false,
"mirror_user_id": 45,
"mirror_trigger_builds": false,
"only_mirror_protected_branches": false,
"mirror_overwrites_diverged_branches": false,
"external_authorization_classification_label": null,
"packages_enabled": true,
"service_desk_enabled": false,
"service_desk_address": null,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"autoclose_referenced_issues": true,
"suggestion_commit_message": null,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"statistics": {
"commit_count": 12,
"storage_size": 2066080,
"repository_size": 2066080,
New upstream version 12.0.8
2019-09-04 21:01:54 +05:30
"wiki_size" : 0,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"lfs_objects_size": 0,
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
"job_artifacts_size": 0,
New upstream version 13.2.1
2020-07-28 23:09:34 +05:30
"packages_size": 0,
"snippets_size": 0
New upstream version 9.5.4+dfsg
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"
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
}
New upstream version 8.13.3+dfsg1
2016-11-03 12:29:30 +05:30
}
]
```
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
## List projects starred by a user
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Get a list of visible projects owned by the given user. When accessed without
authentication, only public projects are returned.
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
GET /users/:user_id/starred_projects
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-------------------------------|---------|------------------------|-------------|
| `archived` | boolean | **{dotted-circle}** No | Limit by archived status. |
| `membership` | boolean | **{dotted-circle}** No | Limit by projects that the current user is a member of. |
| `min_access_level` | integer | **{dotted-circle}** No | Limit by current user minimal [access level](members.md#valid-access-levels). |
| `order_by` | string | **{dotted-circle}** No | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at`. |
| `owned` | boolean | **{dotted-circle}** No | Limit by projects explicitly owned by the current user. |
| `search` | string | **{dotted-circle}** No | Return list of projects matching the search criteria. |
| `simple` | boolean | **{dotted-circle}** No | Return only limited fields for each project. This is a no-op without authentication as then _only_ simple fields are returned.. |
| `sort` | string | **{dotted-circle}** No | Return projects sorted in `asc` or `desc` order. Default is `desc`. |
| `starred` | boolean | **{dotted-circle}** No | Limit by projects starred by the current user. |
| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. |
| `user_id` | string | **{check-circle}** Yes | The ID or username of the user. |
| `visibility` | string | **{dotted-circle}** No | Limit by visibility `public`, `internal`, or `private`. |
| `with_custom_attributes` | boolean | **{dotted-circle}** No | Include [custom attributes](custom_attributes.md) in response. _(admins only)_ |
| `with_issues_enabled` | boolean | **{dotted-circle}** No | Limit by enabled issues feature. |
| `with_merge_requests_enabled` | boolean | **{dotted-circle}** No | Limit by enabled merge requests feature. |
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
```shell
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/5/starred_projects"
```
Example response:
```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",
"readme_url": "http://example.com/diaspora/diaspora-client/blob/master/README.md",
"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,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"can_create_merge_request_in": true,
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
"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": 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,
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
"allow_merge_on_skipped_pipeline": false,
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
"only_allow_merge_if_all_discussions_are_resolved": false,
New upstream version 12.5.4
2019-12-26 22:10:19 +05:30
"remove_source_branch_after_merge": false,
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
"request_access_enabled": false,
"merge_method": "merge",
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"autoclose_referenced_issues": true,
"suggestion_commit_message": null,
New upstream version 12.2.8
2019-10-12 21:52:04 +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",
"readme_url": "http://example.com/brightbox/puppet/blob/master/README.md",
"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,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"can_create_merge_request_in": true,
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
"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": 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,
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
"allow_merge_on_skipped_pipeline": false,
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
"only_allow_merge_if_all_discussions_are_resolved": false,
New upstream version 12.5.4
2019-12-26 22:10:19 +05:30
"remove_source_branch_after_merge": false,
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
"request_access_enabled": false,
"merge_method": "merge",
New upstream version 12.6.1
2020-01-01 13:55:28 +05:30
"auto_devops_enabled": true,
"auto_devops_deploy_strategy": "continuous",
"repository_storage": "default",
"approvals_before_merge": 0,
"mirror": false,
"mirror_user_id": 45,
"mirror_trigger_builds": false,
"only_mirror_protected_branches": false,
"mirror_overwrites_diverged_branches": false,
"external_authorization_classification_label": null,
"packages_enabled": true,
"service_desk_enabled": false,
"service_desk_address": null,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"autoclose_referenced_issues": true,
"suggestion_commit_message": null,
New upstream version 12.2.8
2019-10-12 21:52:04 +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"
}
}
]
```
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Get single project
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 9.2.10+dfsg
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.
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
GET /projects/:id
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|--------------------------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `license` | boolean | **{dotted-circle}** No | Include project license data. |
| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. |
| `with_custom_attributes` | boolean | **{dotted-circle}** No | Include [custom attributes](custom_attributes.md) in response. _(admins only)_ |
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
```json
{
"id": 3,
"description": null,
"default_branch": "master",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"visibility": "private",
Imported Upstream version 7.2.1
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",
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
"tag_list": [
"example",
"disapora project"
],
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
"owner": {
"id": 3,
"name": "Diaspora",
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"created_at": "2013-09-30T13:46:02Z"
Imported Upstream version 7.2.1
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,
Imported Upstream version 8.3.0+dfsg
2015-12-23 02:04:40 +05:30
"open_issues_count": 1,
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
"merge_requests_enabled": true,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"jobs_enabled": true,
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
"wiki_enabled": true,
"snippets_enabled": false,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"can_create_merge_request_in": true,
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"container_registry_enabled": false,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"container_expiration_policy": {
"cadence": "7d",
"enabled": false,
"keep_n": null,
"older_than": null,
New upstream version 13.0.0
2020-05-24 23:13:21 +05:30
"name_regex": null, // to be deprecated in GitLab 13.0 in favor of `name_regex_delete`
"name_regex_delete": null,
"name_regex_keep": null,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"next_run_at": "2020-01-07T21:42:58.658Z"
},
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
"creator_id": 3,
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"kind": "group",
New upstream version 11.11.7+dfsg
2019-07-31 22:56:46 +05:30
"full_path": "diaspora",
"avatar_url": "http://localhost:3000/uploads/group/avatar/3/foo.jpg",
"web_url": "http://localhost:3000/groups/diaspora"
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
},
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"import_status": "none",
"import_error": null,
Imported Upstream version 7.2.1
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
}
},
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
"archived": false,
Imported Upstream version 8.4.0+dfsg~rc2
2016-01-19 16:12:03 +05:30
"avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
New upstream version 11.5.3+dfsg
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"
},
Imported Upstream version 8.4.0+dfsg~rc2
2016-01-19 16:12:03 +05:30
"shared_runners_enabled": true,
"forks_count": 0,
"star_count": 0,
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
New upstream version 12.0.8
2019-09-04 21:01:54 +05:30
"ci_default_git_depth": 50,
New upstream version 13.5.5
2021-01-03 14:25:43 +05:30
"ci_forward_deployment_enabled": true,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"public_jobs": true,
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"shared_with_groups": [
{
"group_id": 4,
"group_name": "Twitter",
New upstream version 11.8.0
2019-03-02 22:35:43 +05:30
"group_full_path": "twitter",
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"group_access_level": 30
},
{
"group_id": 3,
"group_name": "Gitlab Org",
New upstream version 11.8.0
2019-03-02 22:35:43 +05:30
"group_full_path": "gitlab-org",
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"group_access_level": 10
}
New upstream version 8.12.1+dfsg1
2016-09-29 09:46:39 +05:30
],
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
"repository_storage": "default",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_pipeline_succeeds": false,
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
"allow_merge_on_skipped_pipeline": false,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_all_discussions_are_resolved": false,
New upstream version 12.5.4
2019-12-26 22:10:19 +05:30
"remove_source_branch_after_merge": false,
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"printing_merge_requests_link_enabled": true,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"request_access_enabled": false,
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
New upstream version 12.6.1
2020-01-01 13:55:28 +05:30
"auto_devops_enabled": true,
"auto_devops_deploy_strategy": "continuous",
"repository_storage": "default",
"approvals_before_merge": 0,
"mirror": false,
"mirror_user_id": 45,
"mirror_trigger_builds": false,
"only_mirror_protected_branches": false,
"mirror_overwrites_diverged_branches": false,
"external_authorization_classification_label": null,
"packages_enabled": true,
"service_desk_enabled": false,
"service_desk_address": null,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"autoclose_referenced_issues": true,
"suggestion_commit_message": null,
New upstream version 13.0.0
2020-05-24 23:13:21 +05:30
"marked_for_deletion_at": "2020-04-03", // Deprecated and will be removed in API v5 in favor of marked_for_deletion_on
New upstream version 12.10.0
2020-04-22 19:07:51 +05:30
"marked_for_deletion_on": "2020-04-03",
New upstream version 13.2.1
2020-07-28 23:09:34 +05:30
"compliance_frameworks": [ "sox" ],
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"statistics": {
"commit_count": 37,
"storage_size": 1038090,
"repository_size": 1038090,
New upstream version 12.0.8
2019-09-04 21:01:54 +05:30
"wiki_size" : 0,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"lfs_objects_size": 0,
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
"job_artifacts_size": 0,
New upstream version 13.2.1
2020-07-28 23:09:34 +05:30
"packages_size": 0,
"snippets_size": 0
New upstream version 9.5.4+dfsg
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"
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
}
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
}
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
can also see the `approvals_before_merge` parameter:
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
```json
{
"id": 3,
"description": null,
"approvals_before_merge": 0,
...
}
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
The `web_url` and `avatar_url` attributes on `namespace` were
[introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/27427)
in GitLab 11.11.
New upstream version 11.11.7+dfsg
2019-07-31 22:56:46 +05:30
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
If the project is a fork, and you provide a valid token to authenticate, the
New upstream version 13.4.6
2020-11-24 15:15:51 +05:30
`forked_from_project` field appears in the response.
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
```json
{
"id":3,
...
"forked_from_project":{
"id":13083,
"description":"GitLab Community Edition",
"name":"GitLab Community Edition",
"name_with_namespace":"GitLab.org / GitLab Community Edition",
New upstream version 12.4.6
2019-12-21 20:55:43 +05:30
"path":"gitlab-foss",
"path_with_namespace":"gitlab-org/gitlab-foss",
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
"created_at":"2013-09-26T06:02:36.000Z",
"default_branch":"master",
"tag_list":[],
New upstream version 12.4.6
2019-12-21 20:55:43 +05:30
"ssh_url_to_repo":"git@gitlab.com:gitlab-org/gitlab-foss.git",
New upstream version 12.3.8
2019-12-04 20:38:33 +05:30
"http_url_to_repo":"https://gitlab.com/gitlab-org/gitlab-foss.git",
"web_url":"https://gitlab.com/gitlab-org/gitlab-foss",
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
"avatar_url":"https://assets.gitlab-static.net/uploads/-/system/project/avatar/13083/logo-extra-whitespace.png",
New upstream version 12.4.6
2019-12-21 20:55:43 +05:30
"license_url": "https://gitlab.com/gitlab-org/gitlab/blob/master/LICENSE",
New upstream version 11.5.3+dfsg
2018-12-13 13:39:08 +05:30
"license": {
"key": "mit",
"name": "MIT License",
"nickname": null,
"html_url": "http://choosealicense.com/licenses/mit/",
"source_url": "https://opensource.org/licenses/MIT",
},
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
"star_count":3812,
"forks_count":3561,
New upstream version 11.2.8+dfsg
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
}
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
}
...
}
```
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
## Get project users
Get the users list of a project.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
GET /projects/:id/users
```
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|--------------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `search` | string | **{dotted-circle}** No | Search for specific users. |
| `skip_users` | integer array | **{dotted-circle}** No | Filter out users with the specified IDs. |
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
```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"
}
]
```
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Get project events
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Refer to the [Events API documentation](events.md#list-a-projects-visible-events).
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Create project
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
Creates a new project owned by the authenticated user.
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
If your HTTP repository isn't publicly accessible, add authentication information
to the URL `https://username:password@gitlab.company.com/group/project.git`,
where `password` is a public access key with the `api` scope enabled.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
POST /projects
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-------------------------------------------------------------|---------|------------------------|-------------|
| `allow_merge_on_skipped_pipeline` | boolean | **{dotted-circle}** No | Set whether or not merge requests can be merged with skipped jobs. |
| `approvals_before_merge` **(STARTER)** | integer | **{dotted-circle}** No | How many approvers should approve merge requests by default. |
| `auto_cancel_pending_pipelines` | string | **{dotted-circle}** No | Auto-cancel pending pipelines. This isn't a boolean, but enabled/disabled. |
| `auto_devops_deploy_strategy` | string | **{dotted-circle}** No | Auto Deploy strategy (`continuous`, `manual` or `timed_incremental`). |
| `auto_devops_enabled` | boolean | **{dotted-circle}** No | Enable Auto DevOps for this project. |
| `autoclose_referenced_issues` | boolean | **{dotted-circle}** No | Set whether auto-closing referenced issues on default branch. |
| `avatar` | mixed | **{dotted-circle}** No | Image file for avatar of the project. |
| `build_coverage_regex` | string | **{dotted-circle}** No | Test coverage parsing. |
| `build_git_strategy` | string | **{dotted-circle}** No | The Git strategy. Defaults to `fetch`. |
| `build_timeout` | integer | **{dotted-circle}** No | The maximum amount of time in minutes that a job is able run (in seconds). |
| `builds_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `ci_config_path` | string | **{dotted-circle}** No | The path to CI configuration file. |
| `container_expiration_policy_attributes` | hash | **{dotted-circle}** No | Update the image cleanup policy for this project. Accepts: `cadence` (string), `keep_n` (string), `older_than` (string), `name_regex` (string), `name_regex_delete` (string), `name_regex_keep` (string), `enabled` (boolean). |
| `container_registry_enabled` | boolean | **{dotted-circle}** No | Enable container registry for this project. |
| `default_branch` | string | **{dotted-circle}** No | `master` by default. |
| `description` | string | **{dotted-circle}** No | Short project description. |
| `emails_disabled` | boolean | **{dotted-circle}** No | Disable email notifications. |
| `external_authorization_classification_label` **(PREMIUM)** | string | **{dotted-circle}** No | The classification label for the project. |
| `forking_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `group_with_project_templates_id` **(PREMIUM)** | integer | **{dotted-circle}** No | For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires `use_custom_template` to be true. |
| `import_url` | string | **{dotted-circle}** No | URL to import repository from. |
| `initialize_with_readme` | boolean | **{dotted-circle}** No | `false` by default. |
| `issues_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `issues_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable issues for this project. Use `issues_access_level` instead. |
| `jobs_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable jobs for this project. Use `builds_access_level` instead. |
| `lfs_enabled` | boolean | **{dotted-circle}** No | Enable LFS. |
| `merge_method` | string | **{dotted-circle}** No | Set the [merge method](#project-merge-method) used. |
| `merge_requests_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `merge_requests_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable merge requests for this project. Use `merge_requests_access_level` instead. |
| `mirror_trigger_builds` **(STARTER)** | boolean | **{dotted-circle}** No | Pull mirroring triggers builds. |
| `mirror` **(STARTER)** | boolean | **{dotted-circle}** No | Enables pull mirroring in a project. |
| `name` | string | **{check-circle}** Yes (if path isn't provided) | The name of the new project. Equals path if not provided. |
| `namespace_id` | integer | **{dotted-circle}** No | Namespace for the new project (defaults to the current user's namespace). |
| `only_allow_merge_if_all_discussions_are_resolved` | boolean | **{dotted-circle}** No | Set whether merge requests can only be merged when all the discussions are resolved. |
| `only_allow_merge_if_pipeline_succeeds` | boolean | **{dotted-circle}** No | Set whether merge requests can only be merged with successful jobs. |
| `packages_enabled` | boolean | **{dotted-circle}** No | Enable or disable packages repository feature. |
| `pages_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, `enabled`, or `public`. |
| `requirements_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, `enabled` or `public` |
| `path` | string | **{check-circle}** Yes (if name isn't provided) | Repository name for new project. Generated based on name if not provided (generated as lowercase with dashes). |
| `printing_merge_request_link_enabled` | boolean | **{dotted-circle}** No | Show link to create/view merge request when pushing from the command line. |
| `public_builds` | boolean | **{dotted-circle}** No | If `true`, jobs can be viewed by non-project members. |
| `remove_source_branch_after_merge` | boolean | **{dotted-circle}** No | Enable `Delete source branch` option by default for all new merge requests. |
| `repository_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `repository_storage` | string | **{dotted-circle}** No | Which storage shard the repository is on. _(admins only)_ |
| `request_access_enabled` | boolean | **{dotted-circle}** No | Allow users to request member access. |
| `resolve_outdated_diff_discussions` | boolean | **{dotted-circle}** No | Automatically resolve merge request diffs discussions on lines changed with a push. |
| `shared_runners_enabled` | boolean | **{dotted-circle}** No | Enable shared runners for this project. |
| `show_default_award_emojis` | boolean | **{dotted-circle}** No | Show default award emojis. |
| `snippets_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `snippets_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable snippets for this project. Use `snippets_access_level` instead. |
| `tag_list` | array | **{dotted-circle}** No | The list of tags for a project; put array of tags, that should be finally assigned to a project. |
| `template_name` | string | **{dotted-circle}** No | When used without `use_custom_template`, name of a [built-in project template](../gitlab-basics/create-project.md#built-in-templates). When used with `use_custom_template`, name of a custom project template. |
| `template_project_id` **(PREMIUM)** | integer | **{dotted-circle}** No | When used with `use_custom_template`, project ID of a custom project template. This is preferable to using `template_name` since `template_name` may be ambiguous. |
| `use_custom_template` **(PREMIUM)** | boolean | **{dotted-circle}** No | Use either custom [instance](../user/admin_area/custom_project_templates.md) or [group](../user/group/custom_project_templates.md) (with `group_with_project_templates_id`) project template. |
| `visibility` | string | **{dotted-circle}** No | See [project visibility level](#project-visibility-level). |
| `wiki_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `wiki_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable wiki for this project. Use `wiki_access_level` instead. |
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Create project for user
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
Creates a new project owned by the specified user. Available only for admins.
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
If your HTTP repository isn't publicly accessible, add authentication information
to the URL `https://username:password@gitlab.company.com/group/project.git`,
where `password` is a public access key with the `api` scope enabled.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
POST /projects/user/:user_id
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-------------------------------------------------------------|---------|------------------------|-------------|
| `allow_merge_on_skipped_pipeline` | boolean | **{dotted-circle}** No | Set whether or not merge requests can be merged with skipped jobs. |
| `approvals_before_merge` **(STARTER)** | integer | **{dotted-circle}** No | How many approvers should approve merge requests by default. |
| `auto_cancel_pending_pipelines` | string | **{dotted-circle}** No | Auto-cancel pending pipelines. This isn't a boolean, but enabled/disabled. |
| `auto_devops_deploy_strategy` | string | **{dotted-circle}** No | Auto Deploy strategy (`continuous`, `manual` or `timed_incremental`). |
| `auto_devops_enabled` | boolean | **{dotted-circle}** No | Enable Auto DevOps for this project. |
| `autoclose_referenced_issues` | boolean | **{dotted-circle}** No | Set whether auto-closing referenced issues on default branch. |
| `avatar` | mixed | **{dotted-circle}** No | Image file for avatar of the project. |
| `build_coverage_regex` | string | **{dotted-circle}** No | Test coverage parsing. |
| `build_git_strategy` | string | **{dotted-circle}** No | The Git strategy. Defaults to `fetch`. |
| `build_timeout` | integer | **{dotted-circle}** No | The maximum amount of time in minutes that a job is able run (in seconds). |
| `builds_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `ci_config_path` | string | **{dotted-circle}** No | The path to CI configuration file. |
| `container_registry_enabled` | boolean | **{dotted-circle}** No | Enable container registry for this project. |
| `description` | string | **{dotted-circle}** No | Short project description. |
| `emails_disabled` | boolean | **{dotted-circle}** No | Disable email notifications. |
| `external_authorization_classification_label` **(PREMIUM)** | string | **{dotted-circle}** No | The classification label for the project. |
| `forking_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `group_with_project_templates_id` **(PREMIUM)** | integer | **{dotted-circle}** No | For group-level custom templates, specifies ID of group from which all the custom project templates are sourced. Leave empty for instance-level templates. Requires `use_custom_template` to be true. |
| `import_url` | string | **{dotted-circle}** No | URL to import repository from. |
| `initialize_with_readme` | boolean | **{dotted-circle}** No | `false` by default. |
| `issues_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `issues_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable issues for this project. Use `issues_access_level` instead. |
| `jobs_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable jobs for this project. Use `builds_access_level` instead. |
| `lfs_enabled` | boolean | **{dotted-circle}** No | Enable LFS. |
| `merge_method` | string | **{dotted-circle}** No | Set the [merge method](#project-merge-method) used. |
| `merge_requests_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `merge_requests_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable merge requests for this project. Use `merge_requests_access_level` instead. |
| `mirror_trigger_builds` **(STARTER)** | boolean | **{dotted-circle}** No | Pull mirroring triggers builds. |
| `mirror` **(STARTER)** | boolean | **{dotted-circle}** No | Enables pull mirroring in a project. |
| `name` | string | **{check-circle}** Yes | The name of the new project. |
| `namespace_id` | integer | **{dotted-circle}** No | Namespace for the new project (defaults to the current user's namespace). |
| `only_allow_merge_if_all_discussions_are_resolved` | boolean | **{dotted-circle}** No | Set whether merge requests can only be merged when all the discussions are resolved. |
| `only_allow_merge_if_pipeline_succeeds` | boolean | **{dotted-circle}** No | Set whether merge requests can only be merged with successful jobs. |
| `packages_enabled` | boolean | **{dotted-circle}** No | Enable or disable packages repository feature. |
| `pages_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, `enabled`, or `public`. |
| `requirements_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, `enabled` or `public` |
| `path` | string | **{dotted-circle}** No | Custom repository name for new project. By default generated based on name. |
| `printing_merge_request_link_enabled` | boolean | **{dotted-circle}** No | Show link to create/view merge request when pushing from the command line. |
| `public_builds` | boolean | **{dotted-circle}** No | If `true`, jobs can be viewed by non-project-members. |
| `remove_source_branch_after_merge` | boolean | **{dotted-circle}** No | Enable `Delete source branch` option by default for all new merge requests. |
| `repository_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `repository_storage` | string | **{dotted-circle}** No | Which storage shard the repository is on. _(admins only)_ |
| `request_access_enabled` | boolean | **{dotted-circle}** No | Allow users to request member access. |
| `resolve_outdated_diff_discussions` | boolean | **{dotted-circle}** No | Automatically resolve merge request diffs discussions on lines changed with a push. |
| `shared_runners_enabled` | boolean | **{dotted-circle}** No | Enable shared runners for this project. |
| `show_default_award_emojis` | boolean | **{dotted-circle}** No | Show default award emojis. |
| `snippets_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `snippets_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable snippets for this project. Use `snippets_access_level` instead. |
| `suggestion_commit_message` | string | **{dotted-circle}** No | The commit message used to apply merge request suggestions. |
| `tag_list` | array | **{dotted-circle}** No | The list of tags for a project; put array of tags, that should be finally assigned to a project. |
| `template_name` | string | **{dotted-circle}** No | When used without `use_custom_template`, name of a [built-in project template](../gitlab-basics/create-project.md#built-in-templates). When used with `use_custom_template`, name of a custom project template. |
| `use_custom_template` **(PREMIUM)** | boolean | **{dotted-circle}** No | Use either custom [instance](../user/admin_area/custom_project_templates.md) or [group](../user/group/custom_project_templates.md) (with `group_with_project_templates_id`) project template. |
| `user_id` | integer | **{check-circle}** Yes | The user ID of the project owner. |
| `visibility` | string | **{dotted-circle}** No | See [project visibility level](#project-visibility-level). |
| `wiki_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `wiki_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable wiki for this project. Use `wiki_access_level` instead. |
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Edit project
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
Updates an existing project.
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
If your HTTP repository isn't publicly accessible, add authentication information
to the URL `https://username:password@gitlab.company.com/group/project.git`,
where `password` is a public access key with the `api` scope enabled.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
PUT /projects/:id
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-------------------------------------------------------------|----------------|------------------------|-------------|
| `allow_merge_on_skipped_pipeline` | boolean | **{dotted-circle}** No | Set whether or not merge requests can be merged with skipped jobs. |
| `approvals_before_merge` **(STARTER)** | integer | **{dotted-circle}** No | How many approvers should approve merge request by default. |
| `auto_cancel_pending_pipelines` | string | **{dotted-circle}** No | Auto-cancel pending pipelines. This isn't a boolean, but enabled/disabled. |
| `auto_devops_deploy_strategy` | string | **{dotted-circle}** No | Auto Deploy strategy (`continuous`, `manual`, or `timed_incremental`). |
| `auto_devops_enabled` | boolean | **{dotted-circle}** No | Enable Auto DevOps for this project. |
| `autoclose_referenced_issues` | boolean | **{dotted-circle}** No | Set whether auto-closing referenced issues on default branch. |
| `avatar` | mixed | **{dotted-circle}** No | Image file for avatar of the project. |
| `build_coverage_regex` | string | **{dotted-circle}** No | Test coverage parsing. |
| `build_git_strategy` | string | **{dotted-circle}** No | The Git strategy. Defaults to `fetch`. |
| `build_timeout` | integer | **{dotted-circle}** No | The maximum amount of time in minutes that a job is able run (in seconds). |
| `builds_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `ci_config_path` | string | **{dotted-circle}** No | The path to CI configuration file. |
| `ci_default_git_depth` | integer | **{dotted-circle}** No | Default number of revisions for [shallow cloning](../ci/pipelines/settings.md#git-shallow-clone). |
| `ci_forward_deployment_enabled` | boolean | **{dotted-circle}** No | When a new deployment job starts, [skip older deployment jobs](../ci/pipelines/settings.md#skip-outdated-deployment-jobs) that are still pending |
| `container_expiration_policy_attributes` | hash | **{dotted-circle}** No | Update the image cleanup policy for this project. Accepts: `cadence` (string), `keep_n` (string), `older_than` (string), `name_regex` (string), `name_regex_delete` (string), `name_regex_keep` (string), `enabled` (boolean). |
| `container_registry_enabled` | boolean | **{dotted-circle}** No | Enable container registry for this project. |
| `default_branch` | string | **{dotted-circle}** No | `master` by default. |
| `description` | string | **{dotted-circle}** No | Short project description. |
| `emails_disabled` | boolean | **{dotted-circle}** No | Disable email notifications. |
| `external_authorization_classification_label` **(PREMIUM)** | string | **{dotted-circle}** No | The classification label for the project. |
| `forking_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `import_url` | string | **{dotted-circle}** No | URL to import repository from. |
| `issues_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `issues_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable issues for this project. Use `issues_access_level` instead. |
| `jobs_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable jobs for this project. Use `builds_access_level` instead. |
| `lfs_enabled` | boolean | **{dotted-circle}** No | Enable LFS. |
| `merge_method` | string | **{dotted-circle}** No | Set the [merge method](#project-merge-method) used. |
| `merge_requests_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `merge_requests_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable merge requests for this project. Use `merge_requests_access_level` instead. |
| `mirror_overwrites_diverged_branches` **(STARTER)** | boolean | **{dotted-circle}** No | Pull mirror overwrites diverged branches. |
| `mirror_trigger_builds` **(STARTER)** | boolean | **{dotted-circle}** No | Pull mirroring triggers builds. |
| `mirror_user_id` **(STARTER)** | integer | **{dotted-circle}** No | User responsible for all the activity surrounding a pull mirror event. _(admins only)_ |
| `mirror` **(STARTER)** | boolean | **{dotted-circle}** No | Enables pull mirroring in a project. |
| `name` | string | **{dotted-circle}** No | The name of the project. |
| `only_allow_merge_if_all_discussions_are_resolved` | boolean | **{dotted-circle}** No | Set whether merge requests can only be merged when all the discussions are resolved. |
| `only_allow_merge_if_pipeline_succeeds` | boolean | **{dotted-circle}** No | Set whether merge requests can only be merged with successful jobs. |
| `only_mirror_protected_branches` **(STARTER)** | boolean | **{dotted-circle}** No | Only mirror protected branches. |
| `packages_enabled` | boolean | **{dotted-circle}** No | Enable or disable packages repository feature. |
| `pages_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, `enabled`, or `public`. |
| `requirements_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, `enabled` or `public` |
| `path` | string | **{dotted-circle}** No | Custom repository name for the project. By default generated based on name. |
| `public_builds` | boolean | **{dotted-circle}** No | If `true`, jobs can be viewed by non-project members. |
| `remove_source_branch_after_merge` | boolean | **{dotted-circle}** No | Enable `Delete source branch` option by default for all new merge requests. |
| `repository_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `repository_storage` | string | **{dotted-circle}** No | Which storage shard the repository is on. _(admins only)_ |
| `request_access_enabled` | boolean | **{dotted-circle}** No | Allow users to request member access. |
| `resolve_outdated_diff_discussions` | boolean | **{dotted-circle}** No | Automatically resolve merge request diffs discussions on lines changed with a push. |
| `service_desk_enabled` | boolean | **{dotted-circle}** No | Enable or disable Service Desk feature. |
| `shared_runners_enabled` | boolean | **{dotted-circle}** No | Enable shared runners for this project. |
| `show_default_award_emojis` | boolean | **{dotted-circle}** No | Show default award emojis. |
| `snippets_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `snippets_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable snippets for this project. Use `snippets_access_level` instead. |
| `suggestion_commit_message` | string | **{dotted-circle}** No | The commit message used to apply merge request suggestions. |
| `tag_list` | array | **{dotted-circle}** No | The list of tags for a project; put array of tags, that should be finally assigned to a project. |
| `visibility` | string | **{dotted-circle}** No | See [project visibility level](#project-visibility-level). |
| `wiki_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. |
| `wiki_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable wiki for this project. Use `wiki_access_level` instead. |
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Fork project
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
New upstream version 8.12.1+dfsg1
2016-09-29 09:46:39 +05:30
Forks a project into the user namespace of the authenticated user or the one provided.
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
The forking operation for a project is asynchronous and is completed in a
New upstream version 13.4.6
2020-11-24 15:15:51 +05:30
background job. The request returns immediately. To determine whether the
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
fork of the project has completed, query the `import_status` for the new project.
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
POST /projects/:id/fork
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|------------------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `name` | string | **{dotted-circle}** No | The name assigned to the resultant project after forking. |
| `namespace_id` | integer | **{dotted-circle}** No | The ID of the namespace that the project is forked to. |
| `namespace_path` | string | **{dotted-circle}** No | The path of the namespace that the project is forked to. |
| `namespace` | integer/string | **{dotted-circle}** No | _(Deprecated)_ The ID or path of the namespace that the project is forked to. |
| `path` | string | **{dotted-circle}** No | The path assigned to the resultant project after forking. |
Imported Upstream version 7.10.0
2015-04-26 12:48:37 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## List Forks of a project
New upstream version 13.3.8
2020-10-24 23:57:45 +05:30
> Introduced in GitLab 10.1.
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
List the projects accessible to the calling user that have an established,
forked relationship with the specified project
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
GET /projects/:id/forks
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-------------------------------|----------------|------------------------|-------------|
| `archived` | boolean | **{dotted-circle}** No | Limit by archived status. |
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `membership` | boolean | **{dotted-circle}** No | Limit by projects that the current user is a member of. |
| `min_access_level` | integer | **{dotted-circle}** No | Limit by current user minimal [access level](members.md#valid-access-levels). |
| `order_by` | string | **{dotted-circle}** No | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at`. |
| `owned` | boolean | **{dotted-circle}** No | Limit by projects explicitly owned by the current user. |
| `search` | string | **{dotted-circle}** No | Return list of projects matching the search criteria. |
| `simple` | boolean | **{dotted-circle}** No | Return only limited fields for each project. This is a no-op without authentication as then _only_ simple fields are returned. |
| `sort` | string | **{dotted-circle}** No | Return projects sorted in `asc` or `desc` order. Default is `desc`. |
| `starred` | boolean | **{dotted-circle}** No | Limit by projects starred by the current user. |
| `statistics` | boolean | **{dotted-circle}** No | Include project statistics. |
| `visibility` | string | **{dotted-circle}** No | Limit by visibility `public`, `internal`, or `private`. |
| `with_custom_attributes` | boolean | **{dotted-circle}** No | Include [custom attributes](custom_attributes.md) in response. _(admins only)_ |
| `with_issues_enabled` | boolean | **{dotted-circle}** No | Limit by enabled issues feature. |
| `with_merge_requests_enabled` | boolean | **{dotted-circle}** No | Limit by enabled merge requests feature. |
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
```shell
New upstream version 11.7.5
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/forks"
New upstream version 10.5.5+dfsg
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",
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",
New upstream version 10.5.5+dfsg
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,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"can_create_merge_request_in": true,
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
"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,
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
"allow_merge_on_skipped_pipeline": false,
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
"only_allow_merge_if_all_discussions_are_resolved": false,
New upstream version 12.5.4
2019-12-26 22:10:19 +05:30
"remove_source_branch_after_merge": false,
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
"request_access_enabled": false,
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"autoclose_referenced_issues": true,
"suggestion_commit_message": null,
New upstream version 10.5.5+dfsg
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
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Stars a given project. Returns status code `304` if the project is already
starred.
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
POST /projects/:id/star
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
```shell
New upstream version 11.7.5
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"
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
```
Example response:
```json
{
"id": 3,
"description": null,
"default_branch": "master",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"visibility": "internal",
Imported Upstream version 8.8.2+dfsg
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",
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",
Imported Upstream version 8.8.2+dfsg
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,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"jobs_enabled": true,
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"wiki_enabled": true,
"snippets_enabled": false,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"can_create_merge_request_in": true,
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
Imported Upstream version 8.10.5+dfsg
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",
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"creator_id": 3,
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"kind": "group",
"full_path": "diaspora"
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
},
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"import_status": "none",
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"archived": true,
"avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
New upstream version 11.5.3+dfsg
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"
},
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"shared_runners_enabled": true,
"forks_count": 0,
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"star_count": 1,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"public_jobs": true,
New upstream version 8.12.1+dfsg1
2016-09-29 09:46:39 +05:30
"shared_with_groups": [],
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_pipeline_succeeds": false,
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
"allow_merge_on_skipped_pipeline": false,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_all_discussions_are_resolved": false,
New upstream version 12.5.4
2019-12-26 22:10:19 +05:30
"remove_source_branch_after_merge": false,
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"request_access_enabled": false,
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"autoclose_referenced_issues": true,
"suggestion_commit_message": null,
New upstream version 9.5.4+dfsg
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"
}
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
}
```
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Unstar a project
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
Unstars a given project. Returns status code `304` if the project is not starred.
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
POST /projects/:id/unstar
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
```shell
New upstream version 11.7.5
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"
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
```
Example response:
```json
{
"id": 3,
"description": null,
"default_branch": "master",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"visibility": "internal",
Imported Upstream version 8.8.2+dfsg
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",
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",
Imported Upstream version 8.8.2+dfsg
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,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"jobs_enabled": true,
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"wiki_enabled": true,
"snippets_enabled": false,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"can_create_merge_request_in": true,
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
Imported Upstream version 8.10.5+dfsg
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",
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"creator_id": 3,
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"kind": "group",
"full_path": "diaspora"
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
},
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"import_status": "none",
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"archived": true,
"avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
New upstream version 11.5.3+dfsg
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"
},
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"shared_runners_enabled": true,
"forks_count": 0,
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"star_count": 0,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"public_jobs": true,
New upstream version 8.12.1+dfsg1
2016-09-29 09:46:39 +05:30
"shared_with_groups": [],
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_pipeline_succeeds": false,
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
"allow_merge_on_skipped_pipeline": false,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_all_discussions_are_resolved": false,
New upstream version 12.5.4
2019-12-26 22:10:19 +05:30
"remove_source_branch_after_merge": false,
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"request_access_enabled": false,
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"autoclose_referenced_issues": true,
"suggestion_commit_message": null,
New upstream version 9.5.4+dfsg
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"
}
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
}
```
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
## List Starrers of a project
List the users who starred the specified project.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
GET /projects/:id/starrers
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `search` | string | **{dotted-circle}** No | Search for specific users. |
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
```shell
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/starrers"
```
Example responses:
```json
[
{
"starred_since": "2019-01-28T14:47:30.642Z",
"user":
{
"id": 1,
"username": "jane_smith",
"name": "Jane Smith",
"state": "active",
"avatar_url": "http://localhost:3000/uploads/user/avatar/1/cd8.jpeg",
"web_url": "http://localhost:3000/jane_smith"
}
},
"starred_since": "2018-01-02T11:40:26.570Z",
"user":
{
"id": 2,
"username": "janine_smith",
"name": "Janine Smith",
"state": "blocked",
"avatar_url": "http://gravatar.com/../e32131cd8.jpeg",
"web_url": "http://localhost:3000/janine_smith"
}
]
```
New upstream version 10.8.7+dfsg
2018-10-15 14:42:47 +05:30
## Languages
Get languages used in a project with percentage value.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 10.8.7+dfsg
2018-10-15 14:42:47 +05:30
GET /projects/:id/languages
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
New upstream version 12.10.0
2020-04-22 19:07:51 +05:30
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
```shell
New upstream version 11.7.5
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/languages"
New upstream version 10.8.7+dfsg
2018-10-15 14:42:47 +05:30
```
Example response:
```json
{
"Ruby": 66.69,
"JavaScript": 22.98,
"HTML": 7.91,
"CoffeeScript": 2.42
}
```
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Archive a project
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Archives the project if the user is either an administrator or the owner of this
project. This action is idempotent, thus archiving an already archived project
does not change the project.
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
POST /projects/:id/archive
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
```shell
New upstream version 11.7.5
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"
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
```
Example response:
```json
{
"id": 3,
"description": null,
"default_branch": "master",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"visibility": "private",
Imported Upstream version 8.8.2+dfsg
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",
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"tag_list": [
"example",
"disapora project"
],
"owner": {
"id": 3,
"name": "Diaspora",
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"created_at": "2013-09-30T13:46:02Z"
Imported Upstream version 8.8.2+dfsg
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,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"jobs_enabled": true,
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"wiki_enabled": true,
"snippets_enabled": false,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"can_create_merge_request_in": true,
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
Imported Upstream version 8.10.5+dfsg
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",
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"creator_id": 3,
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"kind": "group",
"full_path": "diaspora"
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
},
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"import_status": "none",
"import_error": null,
Imported Upstream version 8.8.2+dfsg
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",
New upstream version 11.5.3+dfsg
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"
},
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"shared_runners_enabled": true,
"forks_count": 0,
"star_count": 0,
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
New upstream version 12.0.8
2019-09-04 21:01:54 +05:30
"ci_default_git_depth": 50,
New upstream version 13.5.5
2021-01-03 14:25:43 +05:30
"ci_forward_deployment_enabled": true,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"public_jobs": true,
New upstream version 8.12.1+dfsg1
2016-09-29 09:46:39 +05:30
"shared_with_groups": [],
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_pipeline_succeeds": false,
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
"allow_merge_on_skipped_pipeline": false,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_all_discussions_are_resolved": false,
New upstream version 12.5.4
2019-12-26 22:10:19 +05:30
"remove_source_branch_after_merge": false,
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"request_access_enabled": false,
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"autoclose_referenced_issues": true,
"suggestion_commit_message": null,
New upstream version 9.5.4+dfsg
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"
}
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
}
```
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Unarchive a project
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Unarchives the project if the user is either an administrator or the owner of
this project. This action is idempotent, thus unarchiving a non-archived project
doesn't change the project.
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
POST /projects/:id/unarchive
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
```shell
New upstream version 11.7.5
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"
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
```
Example response:
```json
{
"id": 3,
"description": null,
"default_branch": "master",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"visibility": "private",
Imported Upstream version 8.8.2+dfsg
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",
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
"readme_url": "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"tag_list": [
"example",
"disapora project"
],
"owner": {
"id": 3,
"name": "Diaspora",
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"created_at": "2013-09-30T13:46:02Z"
Imported Upstream version 8.8.2+dfsg
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,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"jobs_enabled": true,
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"wiki_enabled": true,
"snippets_enabled": false,
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"can_create_merge_request_in": true,
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
"resolve_outdated_diff_discussions": false,
Imported Upstream version 8.10.5+dfsg
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",
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"creator_id": 3,
"namespace": {
"id": 3,
"name": "Diaspora",
"path": "diaspora",
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"kind": "group",
"full_path": "diaspora"
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
},
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"import_status": "none",
"import_error": null,
Imported Upstream version 8.8.2+dfsg
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",
New upstream version 11.5.3+dfsg
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"
},
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
"shared_runners_enabled": true,
"forks_count": 0,
"star_count": 0,
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
New upstream version 12.0.8
2019-09-04 21:01:54 +05:30
"ci_default_git_depth": 50,
New upstream version 13.5.5
2021-01-03 14:25:43 +05:30
"ci_forward_deployment_enabled": true,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"public_jobs": true,
New upstream version 8.12.1+dfsg1
2016-09-29 09:46:39 +05:30
"shared_with_groups": [],
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_pipeline_succeeds": false,
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
"allow_merge_on_skipped_pipeline": false,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"only_allow_merge_if_all_discussions_are_resolved": false,
New upstream version 12.5.4
2019-12-26 22:10:19 +05:30
"remove_source_branch_after_merge": false,
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
"request_access_enabled": false,
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
"merge_method": "merge",
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
"autoclose_referenced_issues": true,
"suggestion_commit_message": null,
New upstream version 9.5.4+dfsg
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"
}
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
}
```
New upstream version 13.3.8
2020-10-24 23:57:45 +05:30
## Delete project
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 13.2.1
2020-07-28 23:09:34 +05:30
This endpoint:
New upstream version 12.6.1
2020-01-01 13:55:28 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
- Deletes a project including all associated resources (including issues and
merge requests).
- From [GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/220382) on
[Premium or Silver](https://about.gitlab.com/pricing/) or higher tiers, group
admins can [configure](../user/group/index.md#enabling-delayed-project-removal)
projects within a group to be deleted after a delayed period. When enabled,
actual deletion happens after the number of days specified in the
[default deletion delay](../user/admin_area/settings/visibility_and_access_controls.md#default-deletion-delay).
New upstream version 13.2.1
2020-07-28 23:09:34 +05:30
CAUTION: **Warning:**
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
The default behavior of [Delayed Project deletion](https://gitlab.com/gitlab-org/gitlab/-/issues/32935)
in GitLab 12.6 was changed to [Immediate deletion](https://gitlab.com/gitlab-org/gitlab/-/issues/220382)
New upstream version 13.4.6
2020-11-24 15:15:51 +05:30
in GitLab 13.2, as discussed in [Enabling delayed project removal](../user/group/index.md#enabling-delayed-project-removal).
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
DELETE /projects/:id
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 12.6.1
2020-01-01 13:55:28 +05:30
## Restore project marked for deletion **(PREMIUM)**
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32935) in GitLab 12.6.
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
New upstream version 12.6.1
2020-01-01 13:55:28 +05:30
Restores project marked for deletion.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 12.6.1
2020-01-01 13:55:28 +05:30
POST /projects/:id/restore
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
New upstream version 12.6.1
2020-01-01 13:55:28 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Upload a file
Imported Upstream version 8.4.0+dfsg~rc1
2016-01-14 18:37:52 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Uploads a file to the specified project to be used in an issue or merge request
description, or a comment.
Imported Upstream version 8.4.0+dfsg~rc1
2016-01-14 18:37:52 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 8.4.0+dfsg~rc1
2016-01-14 18:37:52 +05:30
POST /projects/:id/uploads
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `file` | string | **{check-circle}** Yes | The file to be uploaded. |
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
Imported Upstream version 8.4.0+dfsg~rc1
2016-01-14 18:37:52 +05:30
New upstream version 13.4.6
2020-11-24 15:15:51 +05:30
To upload a file from your file system, use the `--form` argument. This causes
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
cURL to post data using the header `Content-Type: multipart/form-data`. The
`file=` parameter must point to a file on your file system and be preceded by
`@`. For example:
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
```shell
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "file=@dk.png" "https://gitlab.example.com/api/v4/projects/5/uploads"
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
```
Returned object:
Imported Upstream version 8.4.0+dfsg~rc1
2016-01-14 18:37:52 +05:30
```json
{
"alt": "dk",
"url": "/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png",
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
"full_path": "/namespace1/project1/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png",
Imported Upstream version 8.4.0+dfsg~rc1
2016-01-14 18:37:52 +05:30
"markdown": "![dk](/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png)"
}
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
The returned `url` is relative to the project path. The returned `full_path` is
the absolute path to the file. In Markdown contexts, the link is expanded when
the format in `markdown` is used.
## Upload a project avatar
Uploads an avatar to the specified project.
```plaintext
PUT /projects/:id
```
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `avatar` | string | **{check-circle}** Yes | The file to be uploaded. |
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
To upload an avatar from your file system, use the `--form` argument. This causes
cURL to post data using the header `Content-Type: multipart/form-data`. The
`file=` parameter must point to an image file on your file system and be
preceded by `@`. For example:
Example request:
```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form "avatar=@dk.png" "https://gitlab.example.com/api/v4/projects/5"
```
Returned object:
```json
{
"avatar_url": "https://gitlab.example.com/uploads/-/system/project/avatar/2/dk.png"
}
```
Imported Upstream version 8.4.0+dfsg~rc1
2016-01-14 18:37:52 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Share project with group
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
Allow to share project with group.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
POST /projects/:id/share
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|----------------|----------------|------------------------|-------------|
| `expires_at` | string | **{dotted-circle}** No | Share expiration date in ISO 8601 format: 2016-09-26 |
| `group_access` | integer | **{check-circle}** Yes | The [access level](members.md#valid-access-levels) to grant the group. |
| `group_id` | integer | **{check-circle}** Yes | The ID of the group to share with. |
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
Imported Upstream version 8.8.2+dfsg
2016-06-02 11:05:42 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Delete a shared project link within a group
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
Unshare the project from the group. Returns `204` and no content on success.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
DELETE /projects/:id/share/:group_id
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|------------|----------------|------------------------|-------------|
| `group_id` | integer | **{check-circle}** Yes | The ID of the group. |
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
```shell
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/share/17"
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
```
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
## Hooks
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Also called Project Hooks and Webhooks. These are different for [System Hooks](system_hooks.md)
that are system-wide.
Imported Upstream version 7.14.3
2015-09-11 14:41:01 +05:30
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
### List project hooks
Get a list of project hooks.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
GET /projects/:id/hooks
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
### Get project hook
Get a specific hook for a project.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
GET /projects/:id/hooks/:hook_id
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|---------------------------|
| `hook_id` | integer | **{check-circle}** Yes | The ID of a project hook. |
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
```json
{
"id": 1,
"url": "http://example.com/hook",
"project_id": 3,
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"push_events": true,
New upstream version 11.3.10+dfsg
2018-11-20 20:47:30 +05:30
"push_events_branch_filter": "",
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"issues_events": true,
New upstream version 10.6.0+dfsg
2018-03-27 19:54:05 +05:30
"confidential_issues_events": true,
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"merge_requests_events": true,
New upstream version 8.12.1+dfsg1
2016-09-29 09:46:39 +05:30
"tag_push_events": true,
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"note_events": true,
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
"confidential_note_events": true,
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
"job_events": true,
New upstream version 8.12.1+dfsg1
2016-09-29 09:46:39 +05:30
"pipeline_events": true,
"wiki_page_events": true,
New upstream version 13.3.8
2020-10-24 23:57:45 +05:30
"deployment_events": true,
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
"releases_events": true,
Imported Upstream version 8.10.5+dfsg
2016-08-24 12:49:21 +05:30
"enable_ssl_verification": true,
Imported Upstream version 7.2.1
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.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
POST /projects/:id/hooks
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|------------------------------|----------------|------------------------|-------------|
| `confidential_issues_events` | boolean | **{dotted-circle}** No | Trigger hook on confidential issues events. |
| `confidential_note_events` | boolean | **{dotted-circle}** No | Trigger hook on confidential note events. |
| `deployment_events` | boolean | **{dotted-circle}** No | Trigger hook on deployment events. |
| `enable_ssl_verification` | boolean | **{dotted-circle}** No | Do SSL verification when triggering the hook. |
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `issues_events` | boolean | **{dotted-circle}** No | Trigger hook on issues events. |
| `job_events` | boolean | **{dotted-circle}** No | Trigger hook on job events. |
| `merge_requests_events` | boolean | **{dotted-circle}** No | Trigger hook on merge requests events. |
| `note_events` | boolean | **{dotted-circle}** No | Trigger hook on note events. |
| `pipeline_events` | boolean | **{dotted-circle}** No | Trigger hook on pipeline events. |
| `push_events_branch_filter` | string | **{dotted-circle}** No | Trigger hook on push events for matching branches only. |
| `push_events` | boolean | **{dotted-circle}** No | Trigger hook on push events. |
| `tag_push_events` | boolean | **{dotted-circle}** No | Trigger hook on tag push events. |
| `token` | string | **{dotted-circle}** No | Secret token to validate received payloads; this isn't returned in the response. |
| `url` | string | **{check-circle}** Yes | The hook URL. |
| `wiki_page_events` | boolean | **{dotted-circle}** No | Trigger hook on wiki events. |
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
### Edit project hook
Edits a hook for a specified project.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
PUT /projects/:id/hooks/:hook_id
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|------------------------------|----------------|------------------------|-------------|
| `confidential_issues_events` | boolean | **{dotted-circle}** No | Trigger hook on confidential issues events. |
| `confidential_note_events` | boolean | **{dotted-circle}** No | Trigger hook on confidential note events. |
| `deployment_events` | boolean | **{dotted-circle}** No | Trigger hook on deployment events. |
| `enable_ssl_verification` | boolean | **{dotted-circle}** No | Do SSL verification when triggering the hook. |
| `hook_id` | integer | **{check-circle}** Yes | The ID of the project hook. |
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `issues_events` | boolean | **{dotted-circle}** No | Trigger hook on issues events. |
| `job_events` | boolean | **{dotted-circle}** No | Trigger hook on job events. |
| `merge_requests_events` | boolean | **{dotted-circle}** No | Trigger hook on merge requests events. |
| `note_events` | boolean | **{dotted-circle}** No | Trigger hook on note events. |
| `pipeline_events` | boolean | **{dotted-circle}** No | Trigger hook on pipeline events. |
| `push_events_branch_filter` | string | **{dotted-circle}** No | Trigger hook on push events for matching branches only. |
| `push_events` | boolean | **{dotted-circle}** No | Trigger hook on push events. |
| `tag_push_events` | boolean | **{dotted-circle}** No | Trigger hook on tag push events. |
| `token` | string | **{dotted-circle}** No | Secret token to validate received payloads; this isn't returned in the response. |
| `url` | string | **{check-circle}** Yes | The hook URL. |
| `wiki_events` | boolean | **{dotted-circle}** No | Trigger hook on wiki events. |
| `releases_events` | boolean | **{dotted-circle}** No | Trigger hook on release events. |
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
### Delete project hook
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Removes a hook from a project. This is an idempotent method and can be called
multiple times. Either the hook is available or not.
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
DELETE /projects/:id/hooks/:hook_id
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `hook_id` | integer | **{check-circle}** Yes | The ID of the project hook. |
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Note the JSON response differs if the hook is available or not. If the project
hook is available before it's returned in the JSON response or an empty response
is returned.
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 11.3.10+dfsg
2018-11-20 20:47:30 +05:30
## Fork relationship
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Allows modification of the forked relationship between existing projects.
Available only for project owners and admins.
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
### Create a forked from/to relation between existing projects
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
POST /projects/:id/fork/:forked_from_id
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|------------------|----------------|------------------------|-------------|
| `forked_from_id` | ID | **{check-circle}** Yes | The ID of the project that was forked from. |
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
### Delete an existing forked from relationship
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
DELETE /projects/:id/fork
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
## Search for projects by name
New upstream version 9.2.10+dfsg
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.
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
GET /projects
Imported Upstream version 7.2.1
2014-09-02 18:07:02 +05:30
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|------------|--------|------------------------|-------------|
| `order_by` | string | **{dotted-circle}** No | Return requests ordered by `id`, `name`, `created_at` or `last_activity_at` fields. |
| `search` | string | **{check-circle}** Yes | A string contained in the project name. |
| `sort` | string | **{dotted-circle}** No | Return requests sorted in `asc` or `desc` order. |
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
```shell
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects?search=test"
New upstream version 9.5.4+dfsg
2017-09-10 17:25:29 +05:30
```
New upstream version 13.4.6
2020-11-24 15:15:51 +05:30
## Start the Housekeeping task for a project
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
> Introduced in GitLab 9.0.
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 9.2.10+dfsg
2017-08-17 22:00:37 +05:30
POST /projects/:id/housekeeping
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID of the project or NAMESPACE/PROJECT_NAME. |
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
## Push Rules **(STARTER)**
### Get project push rules
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Get the [push rules](../push_rules/push_rules.md#enabling-push-rules) of a
project.
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
GET /projects/:id/push_rule
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID of the project or NAMESPACE/PROJECT_NAME. |
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
```json
{
"id": 1,
"project_id": 3,
"commit_message_regex": "Fixes \d+\..*",
"commit_message_negative_regex": "ssh\:\/\/",
"branch_name_regex": "",
"deny_delete_tag": false,
"created_at": "2012-10-12T17:04:47Z",
"member_check": false,
"prevent_secrets": false,
"author_email_regex": "",
"file_name_regex": "",
"max_file_size": 5,
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
"commit_committer_check": false,
"reject_unsigned_commits": false
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
}
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Users of GitLab [Premium, Silver, or higher](https://about.gitlab.com/pricing/)
can also see the `commit_committer_check` and `reject_unsigned_commits`
parameters:
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
```json
{
"id": 1,
"project_id": 3,
New upstream version 12.2.8
2019-10-12 21:52:04 +05:30
"commit_committer_check": false,
"reject_unsigned_commits": false
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
...
}
```
### Add project push rule
Adds a push rule to a specified project.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
POST /projects/:id/push_rule
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------------------------------------------|----------------|------------------------|-------------|
| `author_email_regex` **(STARTER)** | string | **{dotted-circle}** No | All commit author emails must match this, for example `@my-company.com$`. |
| `branch_name_regex` **(STARTER)** | string | **{dotted-circle}** No | All branch names must match this, for example `(feature|hotfix)\/*`. |
| `commit_committer_check` **(PREMIUM)** | boolean | **{dotted-circle}** No | Users can only push commits to this repository that were committed with one of their own verified emails. |
| `commit_message_negative_regex` **(STARTER)** | string | **{dotted-circle}** No | No commit message is allowed to match this, for example `ssh\:\/\/`. |
| `commit_message_regex` **(STARTER)** | string | **{dotted-circle}** No | All commit messages must match this, for example `Fixed \d+\..*`. |
| `deny_delete_tag` **(STARTER)** | boolean | **{dotted-circle}** No | Deny deleting a tag. |
| `file_name_regex` **(STARTER)** | string | **{dotted-circle}** No | All committed filenames must **not** match this, for example `(jar|exe)$`. |
| `id` | integer/string | **{check-circle}** Yes | The ID of the project or NAMESPACE/PROJECT_NAME. |
| `max_file_size` **(STARTER)** | integer | **{dotted-circle}** No | Maximum file size (MB). |
| `member_check` **(STARTER)** | boolean | **{dotted-circle}** No | Restrict commits by author (email) to existing GitLab users. |
| `prevent_secrets` **(STARTER)** | boolean | **{dotted-circle}** No | GitLab will reject any files that are likely to contain secrets. |
| `reject_unsigned_commits` **(PREMIUM)** | boolean | **{dotted-circle}** No | Reject commit when it's not signed through GPG. |
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
### Edit project push rule
Edits a push rule for a specified project.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
PUT /projects/:id/push_rule
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------------------------------------------|----------------|------------------------|-------------|
| `author_email_regex` **(STARTER)** | string | **{dotted-circle}** No | All commit author emails must match this, for example `@my-company.com$`. |
| `branch_name_regex` **(STARTER)** | string | **{dotted-circle}** No | All branch names must match this, for example `(feature|hotfix)\/*`. |
| `commit_committer_check` **(PREMIUM)** | boolean | **{dotted-circle}** No | Users can only push commits to this repository that were committed with one of their own verified emails. |
| `commit_message_negative_regex` **(STARTER)** | string | **{dotted-circle}** No | No commit message is allowed to match this, for example `ssh\:\/\/`. |
| `commit_message_regex` **(STARTER)** | string | **{dotted-circle}** No | All commit messages must match this, for example `Fixed \d+\..*`. |
| `deny_delete_tag` **(STARTER)** | boolean | **{dotted-circle}** No | Deny deleting a tag. |
| `file_name_regex` **(STARTER)** | string | **{dotted-circle}** No | All committed filenames must **not** match this, for example `(jar|exe)$`. |
| `id` | integer/string | **{check-circle}** Yes | The ID of the project or NAMESPACE/PROJECT_NAME. |
| `max_file_size` **(STARTER)** | integer | **{dotted-circle}** No | Maximum file size (MB). |
| `member_check` **(STARTER)** | boolean | **{dotted-circle}** No | Restrict commits by author (email) to existing GitLab users. |
| `prevent_secrets` **(STARTER)** | boolean | **{dotted-circle}** No | GitLab will reject any files that are likely to contain secrets. |
| `reject_unsigned_commits` **(PREMIUM)** | boolean | **{dotted-circle}** No | Reject commits when they are not GPG signed. |
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
### Delete project push rule
> Introduced in [GitLab Starter](https://about.gitlab.com/pricing/) 9.0.
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
Removes a push rule from a project. This is an idempotent method and can be
called multiple times. Either the push rule is available or not.
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
DELETE /projects/:id/push_rule
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
## Transfer a project to a new namespace
> Introduced in GitLab 11.1.
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
PUT /projects/:id/transfer
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-------------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `namespace` | integer/string | **{check-circle}** Yes | The ID or path of the namespace to transfer to project to. |
New upstream version 11.1.8+dfsg
2018-11-08 19:23:39 +05:30
New upstream version 13.5.5
2021-01-03 14:25:43 +05:30
Example request:
```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/transfer?namespace=14"
```
Example response:
```json
{
"id": 7,
"description": "",
"name": "hello-world",
"name_with_namespace": "cute-cats / hello-world",
"path": "hello-world",
"path_with_namespace": "cute-cats/hello-world",
"created_at": "2020-10-15T16:25:22.415Z",
"default_branch": "master",
"tag_list": [],
"ssh_url_to_repo": "git@gitlab.example.com:cute-cats/hello-world.git",
"http_url_to_repo": "https://gitlab.example.com/cute-cats/hello-world.git",
"web_url": "https://gitlab.example.com/cute-cats/hello-world",
"readme_url": "https://gitlab.example.com/cute-cats/hello-world/-/blob/master/README.md",
"avatar_url": null,
"forks_count": 0,
"star_count": 0,
"last_activity_at": "2020-10-15T16:25:22.415Z",
"namespace": {
"id": 18,
"name": "cute-cats",
"path": "cute-cats",
"kind": "group",
"full_path": "cute-cats",
"parent_id": null,
"avatar_url": null,
"web_url": "https://gitlab.example.com/groups/cute-cats"
},
"_links": {
"self": "https://gitlab.example.com/api/v4/projects/7",
"issues": "https://gitlab.example.com/api/v4/projects/7/issues",
"merge_requests": "https://gitlab.example.com/api/v4/projects/7/merge_requests",
"repo_branches": "https://gitlab.example.com/api/v4/projects/7/repository/branches",
"labels": "https://gitlab.example.com/api/v4/projects/7/labels",
"events": "https://gitlab.example.com/api/v4/projects/7/events",
"members": "https://gitlab.example.com/api/v4/projects/7/members"
},
"packages_enabled": true,
"empty_repo": false,
"archived": false,
"visibility": "private",
"resolve_outdated_diff_discussions": false,
"container_registry_enabled": true,
"container_expiration_policy": {
"cadence": "7d",
"enabled": false,
"keep_n": null,
"older_than": null,
"name_regex": null,
"name_regex_keep": null,
"next_run_at": "2020-10-22T16:25:22.746Z"
},
"issues_enabled": true,
"merge_requests_enabled": true,
"wiki_enabled": true,
"jobs_enabled": true,
"snippets_enabled": true,
"service_desk_enabled": false,
"service_desk_address": null,
"can_create_merge_request_in": true,
"issues_access_level": "enabled",
"repository_access_level": "enabled",
"merge_requests_access_level": "enabled",
"forking_access_level": "enabled",
"wiki_access_level": "enabled",
"builds_access_level": "enabled",
"snippets_access_level": "enabled",
"pages_access_level": "enabled",
"emails_disabled": null,
"shared_runners_enabled": true,
"lfs_enabled": true,
"creator_id": 2,
"import_status": "none",
"open_issues_count": 0,
"ci_default_git_depth": 50,
"public_jobs": true,
"build_timeout": 3600,
"auto_cancel_pending_pipelines": "enabled",
"build_coverage_regex": null,
"ci_config_path": null,
"shared_with_groups": [],
"only_allow_merge_if_pipeline_succeeds": false,
"allow_merge_on_skipped_pipeline": null,
"request_access_enabled": true,
"only_allow_merge_if_all_discussions_are_resolved": false,
"remove_source_branch_after_merge": true,
"printing_merge_request_link_enabled": true,
"merge_method": "merge",
"suggestion_commit_message": null,
"auto_devops_enabled": true,
"auto_devops_deploy_strategy": "continuous",
"autoclose_referenced_issues": true,
"approvals_before_merge": 0,
"mirror": false,
"compliance_frameworks": []
}
```
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Branches
Read more in the [Branches](branches.md) documentation.
New upstream version 10.6.0+dfsg
2018-03-27 19:54:05 +05:30
## Project Import/Export
Read more in the [Project import/export](project_import_export.md) documentation.
New upstream version 10.5.5+dfsg
2018-03-17 18:26:18 +05:30
## Project members
Read more in the [Project members](members.md) documentation.
New upstream version 10.6.0+dfsg
2018-03-27 19:54:05 +05:30
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
## Start the pull mirroring process for a Project **(STARTER)**
New upstream version 12.4.6
2019-12-21 20:55:43 +05:30
> Introduced in [GitLab Starter](https://about.gitlab.com/pricing/) 10.3.
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
POST /projects/:id/mirror/pull
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
New upstream version 12.8.6
2020-03-13 15:44:24 +05:30
```shell
New upstream version 13.1.0
2020-06-23 00:09:42 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/mirror/pull"
New upstream version 12.1.11
2019-09-30 21:07:59 +05:30
```
New upstream version 10.6.0+dfsg
2018-03-27 19:54:05 +05:30
## Project badges
Read more in the [Project Badges](project_badges.md) documentation.
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
## Issue and merge request description templates
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
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 with the API
through the [Repositories API](repositories.md) and the [Repository Files API](repository_files.md).
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
New upstream version 12.3.8
2019-12-04 20:38:33 +05:30
## Download snapshot of a Git repository
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
> Introduced in GitLab 10.7
This endpoint may only be accessed by an administrative user.
New upstream version 12.3.8
2019-12-04 20:38:33 +05:30
Download a snapshot of the project (or wiki, if requested) Git repository. This
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
snapshot is always in uncompressed [tar](https://en.wikipedia.org/wiki/Tar_(computing))
format.
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
If a repository is corrupted to the point where `git clone` doesn't work, the
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
snapshot may allow some of the data to be retrieved.
New upstream version 12.9.2
2020-04-08 14:13:33 +05:30
```plaintext
New upstream version 10.7.3+dfsg
2018-05-09 12:01:36 +05:30
GET /projects/:id/snapshot
```
New upstream version 13.6.5
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
|-----------|----------------|------------------------|-------------|
| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
| `wiki` | boolean | **{dotted-circle}** No | Whether to download the wiki, rather than project, repository. |
Reference in a new issue Copy permalink