Projects API

原文：https://docs.gitlab.com/ee/api/projects.html

• Project visibility level
• Project merge method
• List all projects
  • Pagination limits
• List user projects
• List projects starred by a user
• Get single project
• Get project users
• Get project events
• Create project
• Create project for user
• Edit project
• Fork project
• List Forks of a project
• Star a project
• Unstar a project
• List Starrers of a project
• Languages
• Archive a project
• Unarchive a project
• Remove project
• Restore project marked for deletion
• Upload a file
• Share project with group
• Delete a shared project link within a group
• Hooks
  • List project hooks
  • Get project hook
  • Add project hook
  • Edit project hook
  • Delete project hook
• Fork relationship
  • Create a forked from/to relation between existing projects
  • Delete an existing forked from relationship
• Search for projects by name
• Start the Housekeeping task for a Project
• Push Rules
  • Get project push rules
  • Add project push rule
  • Edit project push rule
  • Delete project push rule
• Transfer a project to a new namespace
• Branches
• Project Import/Export
• Project members
• Start the pull mirroring process for a Project
• Project badges
• Issue and merge request description templates
• Download snapshot of a Git repository

Projects API

Project visibility level

GitLab 中的项目可以是私有的，内部的或公共的. 这由项目中的visibility字段确定.

项目可见性级别的值为：

• private ：必须为每个用户显式授予项目访问权限.
• internal ：任何登录的用户都可以克隆该项目.
• public ：无需任何身份验证即可访问该项目.

Project merge method

merge_method当前有三个选项可供选择：

• merge ：为每个合并创建一个合并提交，只要没有冲突就允许合并.
• rebase_merge ：为每个合并创建一个合并提交，但是仅当可能进行快速合并时才允许合并. 这样，您可以确保在合并到目标分支后，如果此合并请求将生成，则该请求也将生成.
• ff ：没有创建合并提交，并且所有合并都被快速转发，这意味着仅当分支可以被快速转发时才允许合并.

List all projects

获取已认证用户跨 GitLab 的所有可见项目的列表. 在未经身份验证的情况下访问时，仅返回带有”简单”字段的公共项目.

GET /projects

注意：此端点支持所选order_by选项的键集分页 .

当simple=true或用户未经身份验证时，这将返回如下内容：

[  {  "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",  ...

当用户通过身份验证且未设置simple ，将返回以下内容：

[  {  "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,  "can_create_merge_request_in":  true,  "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",  "ci_default_git_depth":  50,  "public_jobs":  true,  "shared_with_groups":  [],  "only_allow_merge_if_pipeline_succeeds":  false,  "allow_merge_on_skipped_pipeline":  false,  "only_allow_merge_if_all_discussions_are_resolved":  false,  "remove_source_branch_after_merge":  false,  "request_access_enabled":  false,  "merge_method":  "merge",  "autoclose_referenced_issues":  true,  "suggestion_commit_message":  null,  "marked_for_deletion_at":  "2020-04-03",  //  Deprecated  and  will  be  removed  in  API  v5  in  favor  of  marked_for_deletion_on  "marked_for_deletion_on":  "2020-04-03",  "statistics":  {  "commit_count":  37,  "storage_size":  1038090,  "repository_size":  1038090,  "wiki_size"  :  0,  "lfs_objects_size":  0,  "job_artifacts_size":  0,  "packages_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,  "can_create_merge_request_in":  true,  "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",  "ci_default_git_depth":  0,  "public_jobs":  true,  "shared_with_groups":  [],  "only_allow_merge_if_pipeline_succeeds":  false,  "allow_merge_on_skipped_pipeline":  false,  "only_allow_merge_if_all_discussions_are_resolved":  false,  "remove_source_branch_after_merge":  false,  "request_access_enabled":  false,  "merge_method":  "merge",  "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,  "autoclose_referenced_issues":  true,  "suggestion_commit_message":  null,  "statistics":  {  "commit_count":  12,  "storage_size":  2066080,  "repository_size":  2066080,  "wiki_size"  :  0,  "lfs_objects_size":  0,  "job_artifacts_size":  0,  "packages_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"  }  }  ]

注意：对于使用 GitLab Silver，Premium 或更高版本的用户，已不推荐使用marked_for_deletion_at属性，并将在 API v5 中将其删除，以支持marked_for_deletion_on属性.

在 GitLab 用户入门，青铜或更高还会看到approvals_before_merge参数：

[  {  "id":  4,  "description":  null,  "approvals_before_merge":  0,  ...  }  ]

您可以使用以下自定义属性进行过滤：

GET /projects?custom_attributes[key]=value&custom_attributes[other_key]=other_value

Pagination limits

从 GitLab 13.0 开始， 基于偏移量的分页将被限制为 50,000 条记录 . 要检索超出此限制的项目，将需要进行键集分页 .

请注意，键集分页仅支持order_by=id . 其他排序选项不可用.

List user projects

获取给定用户拥有的可见项目的列表. 在未经身份验证的情况下访问时，仅返回公共项目.

GET /users/:user_id/projects

注意：此端点支持所选order_by选项的键集分页 .

[  {  "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,  "can_create_merge_request_in":  true,  "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",  "ci_default_git_depth":  50,  "public_jobs":  true,  "shared_with_groups":  [],  "only_allow_merge_if_pipeline_succeeds":  false,  "allow_merge_on_skipped_pipeline":  false,  "only_allow_merge_if_all_discussions_are_resolved":  false,  "remove_source_branch_after_merge":  false,  "request_access_enabled":  false,  "merge_method":  "merge",  "autoclose_referenced_issues":  true,  "suggestion_commit_message":  null,  "marked_for_deletion_at":  "2020-04-03",  //  Deprecated  and  will  be  removed  in  API  v5  in  favor  of  marked_for_deletion_on  "marked_for_deletion_on":  "2020-04-03",  "statistics":  {  "commit_count":  37,  "storage_size":  1038090,  "repository_size":  1038090,  "wiki_size"  :  0,  "lfs_objects_size":  0,  "job_artifacts_size":  0,  "packages_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,  "can_create_merge_request_in":  true,  "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",  "ci_default_git_depth":  0,  "public_jobs":  true,  "shared_with_groups":  [],  "only_allow_merge_if_pipeline_succeeds":  false,  "allow_merge_on_skipped_pipeline":  false,  "only_allow_merge_if_all_discussions_are_resolved":  false,  "remove_source_branch_after_merge":  false,  "request_access_enabled":  false,  "merge_method":  "merge",  "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,  "autoclose_referenced_issues":  true,  "suggestion_commit_message":  null,  "statistics":  {  "commit_count":  12,  "storage_size":  2066080,  "repository_size":  2066080,  "wiki_size"  :  0,  "lfs_objects_size":  0,  "job_artifacts_size":  0,  "packages_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"  }  }  ]

List projects starred by a user

获取给定用户拥有的可见项目的列表. 在未经身份验证的情况下访问时，仅返回公共项目.

GET /users/:user_id/starred_projects

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/users/5/starred_projects"

响应示例：

[  {  "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,  "can_create_merge_request_in":  true,  "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,  "allow_merge_on_skipped_pipeline":  false,  "only_allow_merge_if_all_discussions_are_resolved":  false,  "remove_source_branch_after_merge":  false,  "request_access_enabled":  false,  "merge_method":  "merge",  "autoclose_referenced_issues":  true,  "suggestion_commit_message":  null,  "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,  "can_create_merge_request_in":  true,  "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,  "allow_merge_on_skipped_pipeline":  false,  "only_allow_merge_if_all_discussions_are_resolved":  false,  "remove_source_branch_after_merge":  false,  "request_access_enabled":  false,  "merge_method":  "merge",  "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,  "autoclose_referenced_issues":  true,  "suggestion_commit_message":  null,  "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"  }  }  ]

Get single project

获取一个特定的项目. 如果可以公开访问该项目，则无需身份验证即可访问该端点.

GET /projects/:id

{  "id":  3,  "description":  null,  "default_branch":  "master",  "visibility":  "private",  "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",  "readme_url":  "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",  "tag_list":  [  "example",  "disapora project"  ],  "owner":  {  "id":  3,  "name":  "Diaspora",  "created_at":  "2013-09-30T13:46:02Z"  },  "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,  "can_create_merge_request_in":  true,  "resolve_outdated_diff_discussions":  false,  "container_registry_enabled":  false,  "container_expiration_policy":  {  "cadence":  "7d",  "enabled":  false,  "keep_n":  null,  "older_than":  null,  "name_regex":  null,  //  to  be  deprecated  in  GitLab  13.0  in  favor  of  `name_regex_delete`  "name_regex_delete":  null,  "name_regex_keep":  null,  "next_run_at":  "2020-01-07T21:42:58.658Z"  },  "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",  "avatar_url":  "http://localhost:3000/uploads/group/avatar/3/foo.jpg",  "web_url":  "http://localhost:3000/groups/diaspora"  },  "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":  "http://example.com/uploads/project/avatar/3/uploads/avatar.png",  "license_url":  "http://example.com/diaspora/diaspora-client/blob/master/LICENSE",  "license":  {  "key":  "lgpl-3.0",  "name":  "GNU Lesser General Public License v3.0",  "nickname":  "GNU LGPLv3",  "html_url":  "http://choosealicense.com/licenses/lgpl-3.0/",  "source_url":  "http://www.gnu.org/licenses/lgpl-3.0.txt"  },  "shared_runners_enabled":  true,  "forks_count":  0,  "star_count":  0,  "runners_token":  "b8bc4a7a29eb76ea83cf79e4908c2b",  "ci_default_git_depth":  50,  "public_jobs":  true,  "shared_with_groups":  [  {  "group_id":  4,  "group_name":  "Twitter",  "group_full_path":  "twitter",  "group_access_level":  30  },  {  "group_id":  3,  "group_name":  "Gitlab Org",  "group_full_path":  "gitlab-org",  "group_access_level":  10  }  ],  "repository_storage":  "default",  "only_allow_merge_if_pipeline_succeeds":  false,  "allow_merge_on_skipped_pipeline":  false,  "only_allow_merge_if_all_discussions_are_resolved":  false,  "remove_source_branch_after_merge":  false,  "printing_merge_requests_link_enabled":  true,  "request_access_enabled":  false,  "merge_method":  "merge",  "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,  "autoclose_referenced_issues":  true,  "suggestion_commit_message":  null,  "marked_for_deletion_at":  "2020-04-03",  //  Deprecated  and  will  be  removed  in  API  v5  in  favor  of  marked_for_deletion_on  "marked_for_deletion_on":  "2020-04-03",  "compliance_frameworks":  [  "sox"  ],  "statistics":  {  "commit_count":  37,  "storage_size":  1038090,  "repository_size":  1038090,  "wiki_size"  :  0,  "lfs_objects_size":  0,  "job_artifacts_size":  0,  "packages_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"  }  }

在 GitLab 用户入门，青铜或更高还会看到approvals_before_merge参数：

{  "id":  3,  "description":  null,  "approvals_before_merge":  0,  ...  }

注意 ：GitLab 11.11 中引入了namespace上的web_url和avatar_url属性.

如果项目是 fork，并且您提供了有效的令牌进行身份验证，则forked_from_project字段将出现在响应中.

{  "id":3,  ...  "forked_from_project":{  "id":13083,  "description":"GitLab Community Edition",  "name":"GitLab Community Edition",  "name_with_namespace":"GitLab.org / GitLab Community Edition",  "path":"gitlab-foss",  "path_with_namespace":"gitlab-org/gitlab-foss",  "created_at":"2013-09-26T06:02:36.000Z",  "default_branch":"master",  "tag_list":[],  "ssh_url_to_repo":"git@gitlab.com:gitlab-org/gitlab-foss.git",  "http_url_to_repo":"https://gitlab.com/gitlab-org/gitlab-foss.git",  "web_url":"https://gitlab.com/gitlab-org/gitlab-foss",  "avatar_url":"https://assets.gitlab-static.net/uploads/-/system/project/avatar/13083/logo-extra-whitespace.png",  "license_url":  "https://gitlab.com/gitlab-org/gitlab/blob/master/LICENSE",  "license":  {  "key":  "mit",  "name":  "MIT License",  "nickname":  null,  "html_url":  "http://choosealicense.com/licenses/mit/",  "source_url":  "https://opensource.org/licenses/MIT",  },  "star_count":3812,  "forks_count":3561,  "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  }  }  ...  }

Get project users

获取项目的用户列表.

GET /projects/:id/users

[  {  "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"  }  ]

Get project events

请参考Events API 文档 .

Create project

创建一个经过身份验证的用户拥有的新项目.

POST /projects

注意：如果您的 HTTP 存储库不可公开访问，请将身份验证信息添加到 URL： https://username:password@gitlab.company.com/group/project.git ，其中password是启用了api范围的公共访问密钥.

Create project for user

创建一个由指定用户拥有的新项目. 仅适用于管理员.

POST /projects/user/:user_id

注意：如果您的 HTTP 存储库不可公开访问，请将身份验证信息添加到 URL： https://username:password@gitlab.company.com/group/project.git ，其中password是启用了api范围的公共访问密钥.

Edit project

更新现有项目.

PUT /projects/:id

注意：如果您的 HTTP 存储库不可公开访问，请将身份验证信息添加到 URL： https://username:password@gitlab.company.com/group/project.git ，其中password是启用了api范围的公共访问密钥.

Fork project

将项目派生到已认证用户或提供的用户的用户名称空间中.

项目的分叉操作是异步的，并在后台作业中完成. 该请求将立即返回. 要确定项目的分支是否已完成，请查询import_status以获取新项目.

POST /projects/:id/fork

List Forks of a project

注意：此功能是在 GitLab 10.1 中引入的.

列出呼叫用户可访问的与指定项目具有已建立的分叉关系的项目

GET /projects/:id/forks

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/forks"

响应示例：

[  {  "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",  "readme_url":  "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",  "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,  "can_create_merge_request_in":  true,  "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,  "allow_merge_on_skipped_pipeline":  false,  "only_allow_merge_if_all_discussions_are_resolved":  false,  "remove_source_branch_after_merge":  false,  "request_access_enabled":  false,  "merge_method":  "merge",  "autoclose_referenced_issues":  true,  "suggestion_commit_message":  null,  "_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

明星给定的项目. 如果项目已加星标，则返回状态码304 .

POST /projects/:id/star

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/star"

响应示例：

{  "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",  "readme_url":  "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",  "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,  "can_create_merge_request_in":  true,  "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",  "license_url":  "http://example.com/diaspora/diaspora-client/blob/master/LICENSE",  "license":  {  "key":  "lgpl-3.0",  "name":  "GNU Lesser General Public License v3.0",  "nickname":  "GNU LGPLv3",  "html_url":  "http://choosealicense.com/licenses/lgpl-3.0/",  "source_url":  "http://www.gnu.org/licenses/lgpl-3.0.txt"  },  "shared_runners_enabled":  true,  "forks_count":  0,  "star_count":  1,  "public_jobs":  true,  "shared_with_groups":  [],  "only_allow_merge_if_pipeline_succeeds":  false,  "allow_merge_on_skipped_pipeline":  false,  "only_allow_merge_if_all_discussions_are_resolved":  false,  "remove_source_branch_after_merge":  false,  "request_access_enabled":  false,  "merge_method":  "merge",  "autoclose_referenced_issues":  true,  "suggestion_commit_message":  null,  "_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"  }  }

Unstar a project

取消给定项目的星标. 如果项目未加星标，则返回状态码304 .

POST /projects/:id/unstar

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/unstar"

响应示例：

{  "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",  "readme_url":  "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",  "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,  "can_create_merge_request_in":  true,  "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",  "license_url":  "http://example.com/diaspora/diaspora-client/blob/master/LICENSE",  "license":  {  "key":  "lgpl-3.0",  "name":  "GNU Lesser General Public License v3.0",  "nickname":  "GNU LGPLv3",  "html_url":  "http://choosealicense.com/licenses/lgpl-3.0/",  "source_url":  "http://www.gnu.org/licenses/lgpl-3.0.txt"  },  "shared_runners_enabled":  true,  "forks_count":  0,  "star_count":  0,  "public_jobs":  true,  "shared_with_groups":  [],  "only_allow_merge_if_pipeline_succeeds":  false,  "allow_merge_on_skipped_pipeline":  false,  "only_allow_merge_if_all_discussions_are_resolved":  false,  "remove_source_branch_after_merge":  false,  "request_access_enabled":  false,  "merge_method":  "merge",  "autoclose_referenced_issues":  true,  "suggestion_commit_message":  null,  "_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"  }  }

List Starrers of a project

列出为指定项目加注星标的用户.

GET /projects/:id/starrers

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/starrers"

响应示例：

[  {  "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"  }  ]

Languages

获取具有百分比值的项目中使用的语言.

GET /projects/:id/languages

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/languages"

响应示例：

{  "Ruby":  66.69,  "JavaScript":  22.98,  "HTML":  7.91,  "CoffeeScript":  2.42  }

Archive a project

如果用户是该项目的管理员或项目所有者，则归档该项目. 此操作是幂等的，因此归档已归档的项目不会更改该项目.

POST /projects/:id/archive

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/archive"

响应示例：

{  "id":  3,  "description":  null,  "default_branch":  "master",  "visibility":  "private",  "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",  "readme_url":  "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",  "tag_list":  [  "example",  "disapora project"  ],  "owner":  {  "id":  3,  "name":  "Diaspora",  "created_at":  "2013-09-30T13:46:02Z"  },  "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,  "can_create_merge_request_in":  true,  "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",  "import_error":  null,  "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",  "license_url":  "http://example.com/diaspora/diaspora-client/blob/master/LICENSE",  "license":  {  "key":  "lgpl-3.0",  "name":  "GNU Lesser General Public License v3.0",  "nickname":  "GNU LGPLv3",  "html_url":  "http://choosealicense.com/licenses/lgpl-3.0/",  "source_url":  "http://www.gnu.org/licenses/lgpl-3.0.txt"  },  "shared_runners_enabled":  true,  "forks_count":  0,  "star_count":  0,  "runners_token":  "b8bc4a7a29eb76ea83cf79e4908c2b",  "ci_default_git_depth":  50,  "public_jobs":  true,  "shared_with_groups":  [],  "only_allow_merge_if_pipeline_succeeds":  false,  "allow_merge_on_skipped_pipeline":  false,  "only_allow_merge_if_all_discussions_are_resolved":  false,  "remove_source_branch_after_merge":  false,  "request_access_enabled":  false,  "merge_method":  "merge",  "autoclose_referenced_issues":  true,  "suggestion_commit_message":  null,  "_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"  }  }

Unarchive a project

如果用户是该项目的管理员或项目所有者，则取消归档该项目. 此操作是幂等的，因此取消存档未存档的项目不会更改该项目.

POST /projects/:id/unarchive

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/unarchive"

响应示例：

{  "id":  3,  "description":  null,  "default_branch":  "master",  "visibility":  "private",  "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",  "readme_url":  "http://example.com/diaspora/diaspora-project-site/blob/master/README.md",  "tag_list":  [  "example",  "disapora project"  ],  "owner":  {  "id":  3,  "name":  "Diaspora",  "created_at":  "2013-09-30T13:46:02Z"  },  "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,  "can_create_merge_request_in":  true,  "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",  "import_error":  null,  "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",  "license_url":  "http://example.com/diaspora/diaspora-client/blob/master/LICENSE",  "license":  {  "key":  "lgpl-3.0",  "name":  "GNU Lesser General Public License v3.0",  "nickname":  "GNU LGPLv3",  "html_url":  "http://choosealicense.com/licenses/lgpl-3.0/",  "source_url":  "http://www.gnu.org/licenses/lgpl-3.0.txt"  },  "shared_runners_enabled":  true,  "forks_count":  0,  "star_count":  0,  "runners_token":  "b8bc4a7a29eb76ea83cf79e4908c2b",  "ci_default_git_depth":  50,  "public_jobs":  true,  "shared_with_groups":  [],  "only_allow_merge_if_pipeline_succeeds":  false,  "allow_merge_on_skipped_pipeline":  false,  "only_allow_merge_if_all_discussions_are_resolved":  false,  "remove_source_branch_after_merge":  false,  "request_access_enabled":  false,  "merge_method":  "merge",  "autoclose_referenced_issues":  true,  "suggestion_commit_message":  null,  "_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"  }  }

Remove project

该端点：

• 删除包含所有相关资源（问题，合并请求等）的项目.
• 从Premium 或 Silver或更高级别的GitLab 12.6开始，将项目标记为删除. 实际删除发生在实例设置中指定的天数之后.

DELETE /projects/:id

Restore project marked for deletion

在 GitLab 12.6 中引入 .

恢复标记为删除的项目.

POST /projects/:id/restore

Upload a file

将文件上载到指定的项目，以在发布或合并请求描述或注释中使用.

POST /projects/:id/uploads

要从文件系统上载文件，请使用--form参数. 这将导致 cURL 使用标题Content-Type: multipart/form-data . file=参数必须指向文件系统上的文件，并以@开头. 例如：

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "file=@dk.png" "https://gitlab.example.com/api/v4/projects/5/uploads"

Returned object:

{  "alt":  "dk",  "url":  "/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png",  "full_path":  "/namespace1/project1/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png",  "markdown":  "![dk](/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png)"  }

注意 ：返回的url是相对于项目路径的. 返回的full_path是文件的绝对路径. 在 Markdown 上下文中，当使用markdown的格式时，链接会自动展开.

Share project with group

允许与小组共享项目.

POST /projects/:id/share

Delete a shared project link within a group

从小组取消共享项目. 返回204 ，成功则不返回任何内容.

DELETE /projects/:id/share/:group_id

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/share/17"

Hooks

也称为 Project Hooks 和 Webhooks. 对于系统范围的系统挂钩 ，这些是不同的.

List project hooks

获取项目挂钩的列表.

GET /projects/:id/hooks

Get project hook

获取项目的特定挂钩.

GET /projects/:id/hooks/:hook_id

{  "id":  1,  "url":  "http://example.com/hook",  "project_id":  3,  "push_events":  true,  "push_events_branch_filter":  "",  "issues_events":  true,  "confidential_issues_events":  true,  "merge_requests_events":  true,  "tag_push_events":  true,  "note_events":  true,  "confidential_note_events":  true,  "job_events":  true,  "pipeline_events":  true,  "wiki_page_events":  true,  "enable_ssl_verification":  true,  "created_at":  "2012-10-12T17:04:47Z"  }

Add project hook

将钩子添加到指定项目.

POST /projects/:id/hooks

Edit project hook

Edits a hook for a specified project.

PUT /projects/:id/hooks/:hook_id

Delete project hook

从项目中删除一个钩子. 这是幂等方法，可以多次调用. 挂钩是否可用.

DELETE /projects/:id/hooks/:hook_id

请注意，无论挂钩是否可用，JSON 响应都会有所不同. 如果项目挂钩在 JSON 响应中返回之前可用，或者返回空响应.

Fork relationship

允许修改现有项目之间的分支关系. 仅适用于项目所有者和管理员.

Create a forked from/to relation between existing projects

POST /projects/:id/fork/:forked_from_id

Delete an existing forked from relationship

DELETE /projects/:id/fork

Search for projects by name

通过名称搜索可通过身份验证的用户访问的项目. 如果可以公开访问该项目，则无需身份验证即可访问该端点.

GET /projects

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects?search=test"

Start the Housekeeping task for a Project

在 GitLab 9.0 中引入.

POST /projects/:id/housekeeping

Push Rules

Get project push rules

获取项目的推送规则.

GET /projects/:id/push_rule

{  "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,  "commit_committer_check":  false,  "reject_unsigned_commits":  false  }