项目可见性级别
弃用的属性
获取单个项目
- 议题和合并请求模板
列出项目
获取属性
管理项目
删除项目
共享项目
- 与群组共享项目
- 删除群组中的共享项目链接
开启项目的 housekeeping 任务
实时安全扫描
项目徽章
下载 Git 仓库的快照
获取仓库存储的路径

项目 API

使用 REST API 与项目交互。

用户：

具有项目上的任何[默认角色]都可以读取项目的参数。
具有项目上的拥有者或维护者角色的用户可以编辑项目的参数。

项目可见性级别

极狐GitLab 中的项目可以是：

私有的
内部的
公开的

可见性级别由项目中的可见性字段确定。

有关更多信息，请阅读项目可见性。

响应中返回的字段根据经过身份验证的用户的权限而有所不同。

弃用的属性

以下属性已弃用，将在未来版本的 REST API 中删除。请使用替代属性。

弃用属性	替代属性
`tag_list`	`topics` 属性
`marked_for_deletion_at`	`marked_for_deletion_on`。仅限专业版和旗舰版。
`approvals_before_merge`	合并请求审核 API。仅限专业版和旗舰版。

获取单个项目

获取某个指定的项目。如果项目是公开可访问的，则此端点的访问无需认证。

GET /projects/:id

支持的参数：

属性	类型	是否必需	描述
`id`	integer or string	Yes	ID 或 URL 编码的项目路径。
`license`	boolean	No	包括项目的许可证数据。
`statistics`	boolean	No	包括项目统计。仅为至少具有报告者角色的用户可用。
`with_custom_attributes`	boolean	No	响应中包含自定义属性。（仅限管理员）

示例响应：

{
  "id": 3,
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
  "default_branch": "main",
  "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/main/README.md",
  "tag_list": [ //deprecated, use `topics` instead
    "example",
    "disapora project"
  ],
  "topics": [
    "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, // deprecated, use container_registry_access_level instead
  "container_registry_access_level": "disabled",
  "security_and_compliance_access_level": "disabled",
  "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",
  "updated_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_url": null,
  "import_type": null,
  "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/main/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,
  "group_runners_enabled": true,
  "forks_count": 0,
  "star_count": 0,
  "runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
  "ci_default_git_depth": 50,
  "ci_forward_deployment_enabled": true,
  "ci_forward_deployment_rollback_allowed": true,
  "ci_allow_fork_pipelines_to_run_in_parent_project": true,
  "ci_separated_caches": true,
  "ci_restrict_pipeline_cancellation_role": "developer",
  "ci_pipeline_variables_minimum_override_role": "maintainer",
  "ci_push_repository_for_job_token_allowed": false,
  "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,
  "allow_pipeline_trigger_approve_deployment": false,
  "restrict_user_defined_variables": 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",
  "squash_option": "default_on",
  "auto_devops_enabled": true,
  "auto_devops_deploy_strategy": "continuous",
  "approvals_before_merge": 0, // Deprecated. Use merge request approvals API instead.
  "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,
  "enforce_auth_checks_on_uploads": true,
  "merge_commit_template": null,
  "squash_commit_template": null,
  "issue_branch_template": "gitlab/%{id}-%{title}",
  "marked_for_deletion_at": "2020-04-03", // Deprecated in favor of marked_for_deletion_on. Planned for removal in a future version of the REST API.
  "marked_for_deletion_on": "2020-04-03",
  "compliance_frameworks": [ "sox" ],
  "warn_about_potentially_unwanted_characters": true,
  "pre_receive_secret_detection_enabled": false,
  "statistics": {
    "commit_count": 37,
    "storage_size": 1038090,
    "repository_size": 1038090,
    "wiki_size" : 0,
    "lfs_objects_size": 0,
    "job_artifacts_size": 0,
    "pipeline_artifacts_size": 0,
    "packages_size": 0,
    "snippets_size": 0,
    "uploads_size": 0,
    "container_registry_size": 0
  },
  "container_registry_image_prefix": "registry.example.com/diaspora/diaspora-client",
  "_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",
    "cluster_agents": "http://example.com/api/v4/projects/1/cluster_agents"
  }
}

在极狐GitLab 15.5 及以后版本中，极狐GitLab 专业版用户还可以看到 only_allow_merge_if_all_status_checks_passed 参数：

{
  "id": 1,
  "project_id": 3,
  "only_allow_merge_if_all_status_checks_passed": false,
  ...
}

如果项目是派生的，forked_from_project 字段会出现在响应中。对于此字段，如果上游项目是私有的，必须提供有效的身份验证令牌。mr_default_target_self 字段也会出现。如果此值为 false，则所有合并请求默认目标上游项目。

{
   "id":3,

   ...

   "mr_default_target_self": false,
   "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":"main",
      "tag_list":[], //deprecated, use `topics` instead
      "topics":[],
      "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://gitlab.com/uploads/-/system/project/avatar/13083/logo-extra-whitespace.png",
      "license_url": "https://gitlab.com/gitlab-org/gitlab/-/blob/main/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
      },
      "repository_storage": "default"
   }

   ...

}

议题和合并请求模板

极狐GitLab 专业版和旗舰版用户还能够看到 issues_template 和 merge_requests_template 参数来管理议题和合并请求描述模板。

{
  "id": 3,
  "issues_template": null,
  "merge_requests_template": null,
  ...
}

列出项目

列出项目。

列出所有项目

获取经过身份验证的用户在极狐GitLab 中获取所有可见项目的列表。未经身份验证访问时，仅使用简单字段返回公开项目。

GET /projects

参数	类型	是否必需	描述
`archived`	boolean	No	归档状态。
`build_coverage_regex`	string	No	测试覆盖率解析（已废弃，计划删除）。
`id_after`	integer	No	ID 大于指定 ID 的项目。
`id_before`	integer	No	ID 小于指定 ID 的项目。
`imported`	boolean	No	当前用户从外部系统导入的项目。
`last_activity_after`	datetime	No	指定时间后具有最后活动的项目。格式：ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`)。
`last_activity_before`	datetime	No	指定时间前具有最后活动的项目。格式：ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`)。
`membership`	boolean	No	当前用户所属的项目。
`min_access_level`	integer	No	当前用户最小角色 (`access_level`)。
`order_by`	string	No	返回按 `id`、`name`、`path`、`created_at`、`updated_at`、`last_activity_at` 或 `similarity` 字段排序的项目。`repository_size`、`storage_size`、`packages_size` 或 `wiki_size` 字段只允许管理员使用。`similarity`（引入于 14.1 版本）仅在搜索时可用，并且仅限于当前用户所属的项目。默认是`created_at`。
`owned`	boolean	No	当前用户明确拥有的项目。
`repository_checksum_failed`	boolean	No	存储库校验和计算失败的项目。
`repository_storage`	string	No	存储在 `repository_storage` 上的项目。（仅管理员）
`search_namespaces`	boolean	No	匹配搜索条件时包括上级命名空间。默认为 `false`。
`search`	string	No	返回符合搜索条件的项目列表。
`simple`	boolean	No	仅返回每个项目的有限字段。如果没有进行身份验证，则为空操作，只返回简单的字段。
`sort`	string	No	返回按 `asc` 或 `desc` 顺序排序的项目。默认是 `desc`。
`starred`	boolean	No	由当前用户加星标的项目。
`statistics`	boolean	No	包括项目统计。仅对至少具有报告者角色的用户可用。
`topic`	string	No	逗号分隔的主题名称。与所有给定主题匹配的项目。请参阅 `topics` 参数。
`topic_id`	integer	No	具有由主题 ID 给出的指定主题的项目。
`visibility`	string	No	可见性 `public`、`internal` 或 `private`。
`wiki_checksum_failed`	boolean	No	wiki 校验和计算失败的项目。
`with_custom_attributes`	boolean	No	在响应中包含自定义属性。（仅管理员）
`with_issues_enabled`	boolean	No	启用了议题功能。
`with_merge_requests_enabled`	boolean	No	启用了合并请求功能。
`with_programming_language`	string	No	使用给定编程语言的项目。
`updated_before`	datetime	No	将结果限制为在指定时间之前最后更新的项目。格式：ISO 8601（`YYYY-MM-DDTHH:MM:SSZ`）。引入于 15.10。要使此过滤器生效，您还必须将 `updated_at` 提供为 `order_by` 参数。
`updated_after`	datetime	No	将结果限制为在指定时间之后最后更新的项目。格式：ISO 8601（`YYYY-MM-DDTHH:MM:SSZ`）。引入于 15.10。要使此过滤器生效，您还必须将 `updated_at` 提供为 `order_by` 参数。

此端点支持所选 order_by 选项的 keyset 分页。

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

请求示例：

curl --request GET "https://gitlab.example.com/api/v4/projects"

响应示例：

[
  {
    "id": 4,
    "description": null,
    "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",
    "default_branch": "main",
    "tag_list": [
      "example",
      "disapora client"
    ],
    "topics": [
      "example",
      "disapora client"
    ],
    "ssh_url_to_repo": "git@gitlab.example.com:diaspora/diaspora-client.git",
    "http_url_to_repo": "https://gitlab.example.com/diaspora/diaspora-client.git",
    "web_url": "https://gitlab.example.com/diaspora/diaspora-client",
    "avatar_url": "https://gitlab.example.com/uploads/project/avatar/4/uploads/avatar.png",
    "star_count": 0,
    "last_activity_at": "2013-09-30T13:46:02Z",
    "namespace": {
      "id": 2,
      "name": "Diaspora",
      "path": "diaspora",
      "kind": "group",
      "full_path": "diaspora",
      "parent_id": null,
      "avatar_url": null,
      "web_url": "https://gitlab.example.com/diaspora"
    }
  },
  {
    ...
  }

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

[
  {
    "id": 4,
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
    "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
    "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",
    "updated_at": "2013-09-30T13:46:02Z",
    "default_branch": "main",
    "tag_list": [ //deprecated, use `topics` instead
      "example",
      "disapora client"
    ],
    "topics": [
      "example",
      "disapora client"
    ],
    "ssh_url_to_repo": "git@gitlab.example.com:diaspora/diaspora-client.git",
    "http_url_to_repo": "https://gitlab.example.com/diaspora/diaspora-client.git",
    "web_url": "https://gitlab.example.com/diaspora/diaspora-client",
    "readme_url": "https://gitlab.example.com/diaspora/diaspora-client/blob/master/README.md",
    "avatar_url": "https://gitlab.example.com/uploads/project/avatar/4/uploads/avatar.png",
    "forks_count": 0,
    "star_count": 0,
    "last_activity_at": "2022-06-24T17:11:26.841Z",
    "namespace": {
      "id": 3,
      "name": "Diaspora",
      "path": "diaspora",
      "kind": "group",
      "full_path": "diaspora",
      "parent_id": null,
      "avatar_url": "https://gitlab.example.com/uploads/project/avatar/6/uploads/avatar.png",
      "web_url": "https://gitlab.example.com/diaspora"
    },
    "container_registry_image_prefix": "registry.gitlab.example.com/diaspora/diaspora-client",
    "_links": {
      "self": "https://gitlab.example.com/api/v4/projects/4",
      "issues": "https://gitlab.example.com/api/v4/projects/4/issues",
      "merge_requests": "https://gitlab.example.com/api/v4/projects/4/merge_requests",
      "repo_branches": "https://gitlab.example.com/api/v4/projects/4/repository/branches",
      "labels": "https://gitlab.example.com/api/v4/projects/4/labels",
      "events": "https://gitlab.example.com/api/v4/projects/4/events",
      "members": "https://gitlab.example.com/api/v4/projects/4/members",
      "cluster_agents": "https://gitlab.example.com/api/v4/projects/4/cluster_agents"
    },
    "packages_enabled": true,
    "empty_repo": false,
    "archived": false,
    "visibility": "public",
    "resolve_outdated_diff_discussions": false,
    "container_expiration_policy": {
      "cadence": "1month",
      "enabled": true,
      "keep_n": 1,
      "older_than": "14d",
      "name_regex": "",
      "name_regex_keep": ".*-main",
      "next_run_at": "2022-06-25T17:11:26.865Z"
    },
    "issues_enabled": true,
    "merge_requests_enabled": true,
    "wiki_enabled": true,
    "jobs_enabled": true,
    "snippets_enabled": true,
    "container_registry_enabled": true,
    "service_desk_enabled": true,
    "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",
    "analytics_access_level": "enabled",
    "container_registry_access_level": "enabled",
    "security_and_compliance_access_level": "private",
    "emails_disabled": null,
    "shared_runners_enabled": true,
    "group_runners_enabled": true,
    "lfs_enabled": true,
    "creator_id": 1,
    "import_url": null,
    "import_type": null,
    "import_status": "none",
    "import_error": null,
    "open_issues_count": 0,
    "ci_default_git_depth": 20,
    "ci_forward_deployment_enabled": true,
    "ci_allow_fork_pipelines_to_run_in_parent_project": true,
    "ci_job_token_scope_enabled": false,
    "ci_separated_caches": true,
    "public_jobs": true,
    "build_timeout": 3600,
    "auto_cancel_pending_pipelines": "enabled",
    "ci_config_path": "",
    "shared_with_groups": [],
    "only_allow_merge_if_pipeline_succeeds": false,
    "allow_merge_on_skipped_pipeline": null,
    "restrict_user_defined_variables": false,
    "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",
    "squash_option": "default_off",
    "enforce_auth_checks_on_uploads": true,
    "suggestion_commit_message": null,
    "merge_commit_template": null,
    "squash_commit_template": null,
    "issue_branch_template": "gitlab/%{id}-%{title}",
    "auto_devops_enabled": false,
    "auto_devops_deploy_strategy": "continuous",
    "autoclose_referenced_issues": true,
    "keep_latest_artifact": true,
    "runner_token_expiration_interval": null,
    "external_authorization_classification_label": "",
    "requirements_enabled": false,
    "requirements_access_level": "enabled",
    "security_and_compliance_enabled": false,
    "compliance_frameworks": [],
    "permissions": {
      "project_access": null,
      "group_access": null
    }
  },
  {
    ...
  }
]

last_activity_at 已基于项目活动和项目事件进行更新。updated_at 在项目记录在数据库中更改时进行更新。

您可以通过自定义属性过滤：

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

请求示例：

curl --globoff --request GET "https://gitlab.example.com/api/v4/projects?custom_attributes[location]=Antarctica&custom_attributes[role]=Developer"

分页限制

在 13.0 及更高版本，offset-based 分页限制为 50000 条记录。Keyset 分页需要检索超出此限制的项目。

Keyset 分页仅支持 order_by=id。其他排序选项不可用。

列出用户项目

获取给定用户拥有的可见项目列表。未经身份验证访问时，仅返回公开项目。

先决条件：

如果想查看特定参数，您必需具有管理员权限或该项目的所有者角色。

仅返回用户（在 user_id 中指定）命名空间中的项目。不返回任何群组或子组中用户拥有的项目。如果配置文件设置为私有，则返回一个空列表。

此端点支持所选 order_by 选项的 keyset 分页。

GET /users/:user_id/projects

参数	类型	是否必需	描述
`archived`	boolean	No	归档状态。
`id_after`	integer	No	ID 大于指定 ID 的项目。
`id_before`	integer	No	ID 小于指定 ID 的项目。
`user_id`	string	Yes	用户的 ID 或用户名。
`membership`	boolean	No	当前用户所属的项目。
`min_access_level`	integer	No	当前用户最低角色 (`access_level`)。
`order_by`	string	No	返回按 `id`、`name`、`path`、`created_at`、`updated_at` 或 `last_activity_at` 字段排序的项目。默认是`created_at`。
`owned`	boolean	No	当前用户明确拥有的项目。
`search`	string	No	返回符合搜索条件的项目列表。
`simple`	boolean	No	仅返回每个项目的有限字段。如果没有进行身份验证，则为空操作，只返回简单的字段。
`sort`	string	No	返回按 `asc` 或 `desc` 顺序排序的项目。默认是 `desc`。
`starred`	boolean	No	由当前用户加星标的项目。
`statistics`	boolean	No	包括项目统计。仅对至少具有报告者角色的用户可用。
`visibility`	string	No	可见性 `public`、`internal` 或 `private`。
`with_custom_attributes`	boolean	No	在响应中包含自定义属性。（仅管理员）
`with_issues_enabled`	boolean	No	启用了议题功能。
`with_merge_requests_enabled`	boolean	No	启用了合并请求功能。
`with_programming_language`	string	No	使用给定编程语言的项目。
`updated_before`	datetime	No	将结果限制为在指定时间之前最后更新的项目。格式：ISO 8601（`YYYY-MM-DDTHH:MM:SSZ`）。引入于 15.10。要使此过滤器生效，您还必须将 `updated_at` 提供为 `order_by` 参数。
`updated_after`	datetime	No	将结果限制为在指定时间之后最后更新的项目。格式：ISO 8601（`YYYY-MM-DDTHH:MM:SSZ`）。引入于 15.10。要使此过滤器生效，您还必须将 `updated_at` 提供为 `order_by` 参数。

[
  {
    "id": 4,
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
    "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
    "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": [ //deprecated, use `topics` instead
      "example",
      "disapora client"
    ],
    "topics": [
      "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, // deprecated, use container_registry_access_level instead
    "container_registry_access_level": "disabled",
    "security_and_compliance_access_level": "disabled",
    "created_at": "2013-09-30T13:46:02Z",
    "updated_at": "2013-09-30T13:46:02Z",
    "last_activity_at": "2013-09-30T13:46:02Z",
    "creator_id": 3,
    "import_url": null,
    "import_type": null,
    "import_status": "none",
    "import_error": null,
    "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,
    "group_runners_enabled": true,
    "forks_count": 0,
    "star_count": 0,
    "runners_token": "b8547b1dc37721d05889db52fa2f02",
    "ci_default_git_depth": 50,
    "ci_forward_deployment_enabled": true,
    "ci_allow_fork_pipelines_to_run_in_parent_project": true,
    "ci_separated_caches": true,
    "public_jobs": true,
    "shared_with_groups": [],
    "only_allow_merge_if_pipeline_succeeds": false,
    "allow_merge_on_skipped_pipeline": false,
    "restrict_user_defined_variables": false,
    "only_allow_merge_if_all_discussions_are_resolved": false,
    "remove_source_branch_after_merge": false,
    "request_access_enabled": false,
    "merge_method": "merge",
    "squash_option": "default_on",
    "autoclose_referenced_issues": true,
    "enforce_auth_checks_on_uploads": true,
    "suggestion_commit_message": null,
    "merge_commit_template": null,
    "squash_commit_template": null,
    "issue_branch_template": "gitlab/%{id}-%{title}",
    "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,
      "pipeline_artifacts_size": 0,
      "packages_size": 0,
      "snippets_size": 0,
      "uploads_size": 0
    },
    "container_registry_image_prefix": "registry.example.com/diaspora/diaspora-client",
    "_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",
      "cluster_agents": "http://example.com/api/v4/projects/1/cluster_agents"
    }
  },
  {
    "id": 6,
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
    "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
    "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": [ //deprecated, use `topics` instead
      "example",
      "puppet"
    ],
    "topics": [
      "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, // deprecated, use container_registry_access_level instead
    "container_registry_access_level": "disabled",
    "security_and_compliance_access_level": "disabled",
    "created_at": "2013-09-30T13:46:02Z",
    "updated_at": "2013-09-30T13:46:02Z",
    "last_activity_at": "2013-09-30T13:46:02Z",
    "creator_id": 3,
    "import_url": null,
    "import_type": null,
    "import_status": "none",
    "import_error": null,
    "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,
    "group_runners_enabled": true,
    "forks_count": 0,
    "star_count": 0,
    "runners_token": "b8547b1dc37721d05889db52fa2f02",
    "ci_default_git_depth": 0,
    "ci_forward_deployment_enabled": true,
    "ci_allow_fork_pipelines_to_run_in_parent_project": true,
    "ci_separated_caches": true,
    "public_jobs": true,
    "shared_with_groups": [],
    "only_allow_merge_if_pipeline_succeeds": false,
    "allow_merge_on_skipped_pipeline": false,
    "restrict_user_defined_variables": false,
    "only_allow_merge_if_all_discussions_are_resolved": false,
    "remove_source_branch_after_merge": false,
    "request_access_enabled": false,
    "merge_method": "merge",
    "squash_option": "default_on",
    "auto_devops_enabled": true,
    "auto_devops_deploy_strategy": "continuous",
    "repository_storage": "default",
    "approvals_before_merge": 0, // Deprecated. Use merge request approvals API instead.
    "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,
    "enforce_auth_checks_on_uploads": true,
    "suggestion_commit_message": null,
    "merge_commit_template": null,
    "squash_commit_template": null,
    "issue_branch_template": "gitlab/%{id}-%{title}",
    "statistics": {
      "commit_count": 12,
      "storage_size": 2066080,
      "repository_size": 2066080,
      "wiki_size" : 0,
      "lfs_objects_size": 0,
      "job_artifacts_size": 0,
      "pipeline_artifacts_size": 0,
      "packages_size": 0,
      "snippets_size": 0,
      "uploads_size": 0
    },
    "container_registry_image_prefix": "registry.example.com/brightbox/puppet",
    "_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",
      "cluster_agents": "http://example.com/api/v4/projects/1/cluster_agents"
    }
  }
]

列出用户做出贡献的项目

获取给定用户贡献的可见项目的列表。

GET /users/:user_id/contributed_projects

参数	类型	是否必需	描述
`user_id`	string	Yes	用户 ID 或用户名
`order_by`	string	No	返回按 `id`、`name`、`path`、`created_at`、`updated_at` 或 `last_activity_at` 字段排序的项目，默认为 `created_at`
`simple`	boolean	No	仅返回每个项目的有限字段。如果未进行身份认证，将不进行任何操作；仅返回简单字段
`sort`	string	No	返回按 `asc` 或 `desc` 顺序排序的项目，默认为 `desc`

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

响应示例：

[
  {
    "id": 4,
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
    "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
    "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": [ //deprecated, use `topics` instead
      "example",
      "disapora client"
    ],
    "topics": [
      "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, // deprecated, use container_registry_access_level instead
    "container_registry_access_level": "disabled",
    "security_and_compliance_access_level": "disabled",
    "created_at": "2013-09-30T13:46:02Z",
    "updated_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,
    "group_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,
    "restrict_user_defined_variables": false,
    "only_allow_merge_if_all_discussions_are_resolved": false,
    "remove_source_branch_after_merge": false,
    "request_access_enabled": false,
    "merge_method": "merge",
    "squash_option": "default_on",
    "autoclose_referenced_issues": true,
    "enforce_auth_checks_on_uploads": true,
    "suggestion_commit_message": null,
    "merge_commit_template": null,
    "squash_commit_template": null,
    "issue_branch_template": "gitlab/%{id}-%{title}",
    "statistics": {
      "commit_count": 37,
      "storage_size": 1038090,
      "repository_size": 1038090,
      "lfs_objects_size": 0,
      "job_artifacts_size": 0,
      "pipeline_artifacts_size": 0,
      "packages_size": 0,
      "snippets_size": 0,
      "uploads_size": 0
    },
    "container_registry_image_prefix": "registry.example.com/diaspora/diaspora-client",
    "_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",
      "cluster_agents": "http://example.com/api/v4/projects/1/cluster_agents"
    }
  },
  {
    "id": 6,
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
    "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
    "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": [ //deprecated, use `topics` instead
      "example",
      "puppet"
    ],
    "topics": [
      "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, // deprecated, use container_registry_access_level instead
    "container_registry_access_level": "disabled",
    "security_and_compliance_access_level": "disabled",
    "created_at": "2013-09-30T13:46:02Z",
    "updated_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,
    "group_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,
    "restrict_user_defined_variables": false,
    "only_allow_merge_if_all_discussions_are_resolved": false,
    "remove_source_branch_after_merge": false,
    "request_access_enabled": false,
    "merge_method": "merge",
    "squash_option": "default_on",
    "auto_devops_enabled": true,
    "auto_devops_deploy_strategy": "continuous",
    "repository_storage": "default",
    "approvals_before_merge": 0, // Deprecated. Use merge request approvals API instead.
    "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,
    "enforce_auth_checks_on_uploads": true,
    "suggestion_commit_message": null,
    "merge_commit_template": null,
    "squash_commit_template": null,
    "issue_branch_template": "gitlab/%{id}-%{title}",
    "statistics": {
      "commit_count": 12,
      "storage_size": 2066080,
      "repository_size": 2066080,
      "lfs_objects_size": 0,
      "job_artifacts_size": 0,
      "pipeline_artifacts_size": 0,
      "packages_size": 0,
      "snippets_size": 0,
      "uploads_size": 0
    },
    "container_registry_image_prefix": "registry.example.com/brightbox/puppet",
    "_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",
      "cluster_agents": "http://example.com/api/v4/projects/1/cluster_agents"
    }
  }
]

通过名称搜索项目

认证用户可以通过名称搜索项目。如果未提供身份验证令牌，则只返回公开项目。

GET /projects

示例属性：

属性	类型	是否必需	描述
`search`	string	Yes	包含项目名称的字符串。
`order_by`	string	No	根据 `id`、`name`、`created_at`、`star_count` 或 `last_activity_at` 字段顺序返回请求。
`sort`	string	No	按照 `asc` 或 `desc` 顺序返回请求。

示例请求：

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

获取属性

列出项目属性。

获取项目用户

获取项目的用户列表。

GET /projects/:id/users

参数	类型	是否必需	描述
`id`	integer or string	Yes	项目的 ID 或 URL 编码的路径。
`search`	string	No	搜索特定用户。
`skip_users`	integer array	No	过滤掉具有指定 ID 的用户。

[
  {
    "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 /projects/:id/groups

参数	类型	是否必需	描述
`id`	integer or string	Yes	项目的 ID 或 URL 编码的路径。
`search`	string	No	搜索特定群组。
`shared_min_access_level`	integer	No	至少具有此角色 (`access_level`)的共享群组。
`shared_visible_only`	boolean	No	用户有权访问的共享群组。
`skip_groups`	array of integers	No	跳过传递的群组 ID。
`with_shared`	boolean	No	是否包括与该群组共享的项目。默认为 `false`。

[
  {
    "id": 1,
    "name": "Foobar Group",
    "avatar_url": "http://localhost:3000/uploads/group/avatar/1/foo.jpg",
    "web_url": "http://localhost:3000/groups/foo-bar",
    "full_name": "Foobar Group",
    "full_path": "foo-bar"
  },
  {
    "id": 2,
    "name": "Shared Group",
    "avatar_url": "http://gitlab.example.com/uploads/group/avatar/1/bar.jpg",
    "web_url": "http://gitlab.example.com/groups/foo/bar",
    "full_name": "Shared Group",
    "full_path": "foo/shared"
  }
]

列出项目的可共享群组

获取可以与项目共享的群组列表。

GET /projects/:id/share_locations

参数	类型	是否必需	描述
`id`	integer or string	Yes	项目的 ID 或 URL 编码的路径
`search`	string	No	搜索特定群组

[
  {
    "id": 22,
    "web_url": "http://127.0.0.1:3000/groups/gitlab-org",
    "name": "Gitlab Org",
    "avatar_url": null,
    "full_name": "Gitlab Org",
    "full_path": "gitlab-org"
  },
  {
    "id": 25,
    "web_url": "http://127.0.0.1:3000/groups/gnuwget",
    "name": "Gnuwget",
    "avatar_url": null,
    "full_name": "Gnuwget",
    "full_path": "gnuwget"
  }
]

列出项目的受邀群组

获取项目中邀请的群组列表。当未经身份验证时，只返回公共邀请的群组。此端点的速率限制为 60个请求/分钟/：

每个认证的用户。
非认证用的 IP 地址。

默认情况下，此请求一次返回 20 个结果，因为API 结果是分页的。

GET /projects/:id/invited_groups

支持的属性：

属性	类型	是否必需	描述
`id`	integer/string	yes	ID 或 URL 编码的群组路径
`search`	string	no	返回与搜索标准相匹配的认证群组列表
`min_access_level`	integer	no	限定在当前用户至少有特定角色 `access_level`的群组
`relation`	array of strings	no	通过关系（直接或继承）来过滤群组
`with_custom_attributes`	boolean	no	在响应中包括自定义属性（仅限管理员）

示例响应：

[
  {
    "id": 35,
    "web_url": "https://gitlab.example.com/groups/twitter",
    "name": "Twitter",
    "avatar_url": null,
    "full_name": "Twitter",
    "full_path": "twitter"
  }
]

列出使用的编程语言

获取项目中使用的编程语言使用百分比列表。

GET /projects/:id/languages

支持的参数：

属性	类型	是否必需	描述
`id`	integer or string	Yes	ID 或 URL 编码的项目路径。

示例请求：

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

Example response:

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

管理项目

管理项目，包括创建、删除和归档。

创建项目

operations_access_level 移除于极狐GitLab 16.0。 - model_registry_access_level 引入于极狐GitLab 16.7。

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

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

POST /projects

请求示例：

curl --request POST --header "PRIVATE-TOKEN: <your-token>" \
     --header "Content-Type: application/json" --data '{
        "name": "new_project", "description": "New Project", "path": "new_project",
        "namespace_id": "42", "initialize_with_readme": "true"}' \
     --url 'https://gitlab.example.com/api/v4/projects/'

disabled：禁用功能。
private：启用并将功能设置为 仅项目成员。
enabled：启用并将功能设置为 任何人都可访问。

属性	类型	是否必需	描述
`analytics_access_level`	string	No	设置分析的可见性。
`builds_access_level`	string	No	设置流水线的可见性。
`container_registry_access_level`	string	No	设置容器镜像仓库的可见性。
`environments_access_level`	string	No	设置环境的可见性。
`feature_flags_access_level`	string	No	设置功能标志的可见性。
`forking_access_level`	string	No	设置派生的可见性。
`infrastructure_access_level`	string	No	设置基础设施管理的可见性。
`issues_access_level`	string	No	设置议题的可见性。
`merge_requests_access_level`	string	No	设置极合并请求的可见性。
`model_experiments_access_level`	string	No	设置机器学习模型试验的可见性。
`model_registry_access_level`	string	No	设置机器学习模型仓库的可见性。
`monitor_access_level`	string	No	设置应用程序性能监控的可见性。
`pages_access_level`	string	No	设置极狐GitLab Pages 的可见性。
`releases_access_level`	string	No	设置版本的可见性。
`repository_access_level`	string	No	设置仓库的可见性。
`requirements_access_level`	string	No	设置需求管理的可见性。
`security_and_compliance_access_level`	string	No	设置安全合规的可见性。
`wiki_access_level`	string	No	设置 wiki的可见性。

示例请求：

curl --request POST --header "PRIVATE-TOKEN: <your-token>" \
     --header "Content-Type: application/json" --data '{
        "name": "new_project", "description": "New Project", "path": "new_project",
        "namespace_id": "42", "initialize_with_readme": "true"}' \
     --url "https://gitlab.example.com/api/v4/projects/"

为用户创建项目

operations_access_level 移除于极狐GitLab 16.0。

model_registry_access_level 引入于极狐GitLab 16.7。

先决条件：

您必须是管理员。

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

POST /projects/user/:user_id

disabled：禁用功能。
private：启用并将功能设置为 仅项目成员。
enabled：启用并将功能设置为 任何人都可访问。

属性	类型	是否必需	描述
`analytics_access_level`	string	No	设置分析的可见性。
`builds_access_level`	string	No	设置流水线的可见性。
`container_registry_access_level`	string	No	设置容器镜像仓库的可见性。
`environments_access_level`	string	No	设置环境的可见性。
`feature_flags_access_level`	string	No	设置功能标志的可见性。
`forking_access_level`	string	No	设置派生的可见性。
`infrastructure_access_level`	string	No	设置基础设施管理的可见性。
`issues_access_level`	string	No	设置议题的可见性。
`merge_requests_access_level`	string	No	设置极合并请求的可见性。
`model_experiments_access_level`	string	No	设置机器学习模型试验的可见性。
`model_registry_access_level`	string	No	设置机器学习模型仓库的可见性。
`monitor_access_level`	string	No	设置应用程序性能监控的可见性。
`pages_access_level`	string	No	设置极狐GitLab Pages 的可见性。
`releases_access_level`	string	No	设置版本的可见性。
`repository_access_level`	string	No	设置仓库的可见性。
`requirements_access_level`	string	No	设置需求管理的可见性。
`security_and_compliance_access_level`	string	No	设置安全合规的可见性。
`wiki_access_level`	string	No	设置 wiki的可见性。

编辑项目

operations_access_level 移除于极狐GitLab 16.0。

model_registry_access_level 引入于极狐GitLab 16.7。

更新现有项目。

PUT /projects/:id

例如：

curl --request PUT --header "PRIVATE-TOKEN: <your-token>" \
     --url 'https://jihulab.com/api/v4/projects/<your-project-ID>' \
     --data "shared_runners_enabled=true" # to turn off: "shared_runners_enabled=false"

支持的参数：

参数	类型	是否必需	描述
`id`	integer or string	Yes	项目的 ID 或 URL 编码的路径。
`allow_merge_on_skipped_pipeline`	boolean	No	设置合并请求是否可以与跳过的作业合并。
`allow_pipeline_trigger_approve_deployment`	boolean	No	设置是否允许流水线触发器批准部署。
`only_allow_merge_if_all_status_checks_passed`	boolean	No	指示应阻止合并请求的合并，除非所有状态检查都已通过。默认为 faulse。引入于极狐GitLab 15.5，默认禁用，功能标志为 `only_allow_merge_if_all_status_checks_passed`。功能标志默认启用于极狐GitLab 15.9。
`analytics_access_level`	string	No	`disabled`、`private` 或 `enabled`。
`approvals_before_merge`	integer	No	默认情况下应有多少审核者批准合并请求。废弃于 16.0。要配置审批规则，请参阅合并请求审批 API。
`auto_cancel_pending_pipelines`	string	No	自动取消挂起的流水线。此操作在启用状态和禁用状态之间切换，不是布尔值。
`auto_devops_deploy_strategy`	string	No	Auto Deploy 策略（`continuous`、`manual` 或 `timed_incremental`）。
`auto_devops_enabled`	boolean	No	为此项目启用 Auto DevOps。
`autoclose_referenced_issues`	boolean	No	设置是否在默认分支上自动关闭引用的议题。
`avatar`	mixed	No	项目头像的图像文件。
`build_git_strategy`	string	No	Git 策略。默认为 `fetch`。
`build_timeout`	integer	No	作业可以运行的最长时间（以秒为单位）。
`builds_access_level`	string	No	`disabled`、`private` 或 `enabled`。
`ci_config_path`	string	No	CI 配置文件的路径。
`ci_default_git_depth`	integer	No	浅克隆的默认修订数。
`ci_forward_deployment_enabled`	boolean	No	启用或禁用防止过期的部署作业。
`ci_allow_fork_pipelines_to_run_in_parent_project`	boolean	No	启用或禁用在父项目中运行来自派生的合并请求的流水线。 (在 GitLab 15.3 中引入。）
`ci_separated_caches`	boolean	No	通过分支保护状态设置缓存是否应分离。
`container_expiration_policy_attributes`	hash	No	更新此项目的镜像清理策略。接受：`cadence`（字符串）、`keep_n`（整数）、`older_than`（字符串）、`name_regex`（字符串）、`name_regex_delete`（字符串）、`name_regex_keep`（字符串）、`enabled`（布尔值）。
`container_registry_access_level`	string	No	将此项目的容器镜像库的可见性设置为 `disabled`、`private` 或 `enabled`。
`container_registry_enabled`	boolean	No	（已废弃）为此项目启用容器镜像库。请改用 `container_registry_access_level`。
`default_branch`	string	No	默认分支名称。
`description`	string	No	简短的项目描述。
`emails_disabled`	boolean	No	禁用电子邮件通知。
`enforce_auth_checks_on_uploads`	boolean	No	在上传上执行授权检查。
`external_authorization_classification_label`	string	No	项目的分类标记。
`forking_access_level`	string	No	`disabled`、`private` 或 `enabled`。
`import_url`	string	No	从中导入仓库的 URL。
`issues_access_level`	string	No	`disabled`、`private` 或 `enabled`。
`issues_enabled`	boolean	No	（已废弃）为此项目启用议题。请改用 `issues_access_level`。
`issues_template`	string	No	议题的默认描述。使用 GFM 解析描述。请参阅议题和合并请求的模板。
`jobs_enabled`	boolean	No	（已废弃）为此项目启用作业。请改用 `builds_access_level`。
`keep_latest_artifact`	boolean	No	禁用或启用为此项目保留最新产物的能力。
`lfs_enabled`	boolean	No	启用 LFS。
`merge_commit_template`	string	No	用于在合并请求中创建合并提交消息的模板。引入于 14.5 版本。
`merge_method`	string	No	设置使用的合并方法。
`merge_pipelines_enabled`	boolean	No	启用或禁用合并流水线。
`merge_requests_access_level`	string	No	`disabled`、`private` 或 `enabled`。
`merge_requests_enabled`	boolean	No	（已废弃）为此项目启用合并请求。请使用 `merge_requests_access_level` 代替。
`merge_requests_template`	string	No	合并请求的默认描述。使用 GFM 解析描述。请参阅议题和合并请求的模板。
`merge_trains_enabled`	boolean	No	启用或禁用合并队列。
`mirror_overwrites_diverged_branches`	boolean	No	拉镜像覆盖分叉的分支。
`mirror_trigger_builds`	boolean	No	拉镜像触发构建。
`mirror_user_id`	integer	No	负责围绕拉镜像事件的所有活动的用户。（仅限管理员）
`mirror`	boolean	No	在项目中启用拉镜像。
`mr_default_target_self`	boolean	No	对于派生项目，将合并请求定位到该项目。如果为 `false`，则目标是上游项目。
`name`	string	No	项目的名称。
`only_allow_merge_if_all_discussions_are_resolved`	boolean	No	设置是否只有在所有讨论都解决后才能合并合并请求。
`only_allow_merge_if_pipeline_succeeds`	boolean	No	设置合并请求是否只能与成功的作业合并。
`only_mirror_protected_branches`	boolean	No	仅镜像受保护的分支。
`packages_enabled`	boolean	No	启用或禁用软件包库功能。
`pages_access_level`	string	No	`disabled`、`private`、`enabled` 或 `public`。
`path`	string	No	项目的自定义仓库名称。默认根据名称生成。
`printing_merge_request_link_enabled`	boolean	No	从命令行推送时显示创建/查看合并请求的链接。
`public_builds`	boolean	No	如果为 `true`，非项目成员可以查看作业。
`releases_access_level`	string	No	`disabled`、`private` 或 `enabled`。
`environments_access_level`	string	No	`disabled`、`private` 或 `enabled`。
`feature_flags_access_level`	string	No	`disabled`、`private` 或 `enabled`。
`infrastructure_access_level`	string	No	`disabled`、`private` 或 `enabled`。
`monitor_access_level`	string	No	`disabled`、`private` 或 `enabled`。
`remove_source_branch_after_merge`	boolean	No	默认为所有新的合并请求启用删除源分支选项。
`repository_access_level`	string	No	`disabled`、`private` 或 `enabled`。
`repository_storage`	string	No	仓库在哪个存储分片上。（仅限管理员）
`request_access_enabled`	boolean	No	允许用户请求成员访问。
`requirements_access_level`	string	No	`disabled`、`private`、`enabled` 或 `public`。
`resolve_outdated_diff_discussions`	boolean	No	自动解决合并请求差异讨论上通过推送更改的行。
`restrict_user_defined_variables`	boolean	No	仅允许具有维护者角色的用户在触发流水线时传递用户定义的变量。例如，当在 UI、API 或触发器令牌中触发流水线时。
`security_and_compliance_access_level`	string	No	（14.9 及更高版本）安全性和合规性访问级别。`disabled`、`private` 或 `enabled`。
`service_desk_enabled`	boolean	No	启用或禁用服务台功能。
`shared_runners_enabled`	boolean	No	为此项目启用共享 Runner。
`group_runners_enabled`	boolean	No	启用项目的群组 Runner。
`snippets_access_level`	string	No	`disabled`、`private` 或 `enabled`。
`snippets_enabled`	boolean	No	（已废弃）为此项目启用代码片段。请使用 `snippets_access_level` 代替。
`issue_branch_template`	sstring	No	从议题创建的分支的建议名称模板。引入于极狐GitLab 15.6。
`squash_commit_template`	string	No	用于在合并请求中创建压缩提交消息的模板。（引入于 14.6 版本）
`squash_option`	string	No	`never`、`always`、`default_on` 或 `default_off`。
`suggestion_commit_message`	string	No	用于应用合并请求建议的提交消息。
`tag_list`	array	No	（废弃于 14.0 版本）项目的标签列表；放置最终应分配给项目的标签数组。请使用 `topics` 代替。
`topics`	array	No	项目的主题列表，将替换已添加到项目中的任何现有主题。引入于 14.0 版本。
`visibility`	string	No	请参阅项目可见性级别。
`wiki_access_level`	string	No	`disabled`、`private` 或 `enabled`。
`wiki_enabled`	boolean	No	（已废弃）为此项目启用 wiki。使用 `wiki_access_level` 代替。

比如，要为在 JihuLab.com 项目上的实例 runner 开启设置：

curl --request PUT --header "PRIVATE-TOKEN: <your-token>" \
     --url "https://gitlab.com/api/v4/projects/<your-project-ID>" \
     --data "shared_runners_enabled=true" # to turn off: "shared_runners_enabled=false"

                                                                                                | [项目功能可见性](../user/public_access.md#change-the-visibility-of-individual-features-in-a-project)的访问控制设置选项可能是以下中的一种：

disabled：禁用功能。
private：启用并将功能设置为 仅项目成员。
enabled：启用并将功能设置为 任何人都可访问。

属性	类型	是否必需	描述
`analytics_access_level`	string	No	设置分析的可见性。
`builds_access_level`	string	No	设置流水线的可见性。
`container_registry_access_level`	string	No	设置容器镜像仓库的可见性。
`environments_access_level`	string	No	设置环境的可见性。
`feature_flags_access_level`	string	No	设置功能标志的可见性。
`forking_access_level`	string	No	设置派生的可见性。
`infrastructure_access_level`	string	No	设置基础设施管理的可见性。
`issues_access_level`	string	No	设置议题的可见性。
`merge_requests_access_level`	string	No	设置极合并请求的可见性。
`model_experiments_access_level`	string	No	设置机器学习模型试验的可见性。
`model_registry_access_level`	string	No	设置机器学习模型仓库的可见性。
`monitor_access_level`	string	No	设置应用程序性能监控的可见性。
`pages_access_level`	string	No	设置极狐GitLab Pages 的可见性。
`releases_access_level`	string	No	设置版本的可见性。
`repository_access_level`	string	No	设置仓库的可见性。
`requirements_access_level`	string	No	设置需求管理的可见性。
`security_and_compliance_access_level`	string	No	设置安全合规的可见性。
`wiki_access_level`	string	No	设置 wiki的可见性。

导入成员

从其他项目导入成员。

如果目标项目的导入成员角色是：

维护者，则源项目具有维护者角色的成员将导入为维护者角色。
所有者，则源项目具有所有者角色的成员将导入为所有者角色。

POST /projects/:id/import_project_members/:project_id

支持的参数：

属性	类型	是否必需	描述
`id`	integer or string	Yes	ID 或接受成员的目标项目的 URL 编码路径。
`project_id`	integer or string	Yes	ID 或导入成员的源项目的 URL 编码路径。

示例请求：

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

200 OK：成功。
404 Project Not Found：如果目标或者源项目不存在或者无法被请求者访问。
422 Unprocessable Entity：如果项目成员的导入未完全成功。

示例响应：

当所有邮件被成功发送（200 HTTP 状态码）：
```
{  "status":  "success"  }
```

当导入一个或多个成员时出现错误（200 HTTP 状态码）：

{
  "status": "error",
  "message": {
               "john_smith": "Some individual error message",
               "jane_smith": "Some individual error message"
             },
  "total_members_count": 3
}

当发生系统错误时（404 和 422 HTTP 状态码）：

{  "message":  "Import failed"  }

归档项目

归档一个项目。

先决条件：

您必须是管理员或被赋予项目的拥有者角色。

此端点是幂等的。归档一个已经归档的项目不会改变项目。

POST /projects/:id/archive

支持的参数：

属性	类型	是否必需	描述
`id`	integer or string	Yes	ID 或 URL 编码的项目路径。

示例请求：

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

示例响应：

{
  "id": 3,
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
  "default_branch": "main",
  "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/main/README.md",
  "tag_list": [ //deprecated, use `topics` instead
    "example",
    "disapora project"
  ],
  "topics": [
    "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",
  "repository_object_format": "sha1",
  "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, // deprecated, use container_registry_access_level instead
  "container_registry_access_level": "disabled",
  "security_and_compliance_access_level": "disabled",
  "created_at": "2013-09-30T13:46:02Z",
  "updated_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/main/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,
  "group_runners_enabled": true,
  "forks_count": 0,
  "star_count": 0,
  "runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
  "ci_default_git_depth": 50,
  "ci_forward_deployment_enabled": true,
  "ci_forward_deployment_rollback_allowed": true,
  "ci_allow_fork_pipelines_to_run_in_parent_project": true,
  "ci_separated_caches": true,
  "ci_restrict_pipeline_cancellation_role": "developer",
  "ci_pipeline_variables_minimum_override_role": "maintainer",
  "ci_push_repository_for_job_token_allowed": false,
  "public_jobs": true,
  "shared_with_groups": [],
  "only_allow_merge_if_pipeline_succeeds": false,
  "allow_merge_on_skipped_pipeline": false,
  "allow_pipeline_trigger_approve_deployment": false,
  "restrict_user_defined_variables": false,
  "only_allow_merge_if_all_discussions_are_resolved": false,
  "remove_source_branch_after_merge": false,
  "request_access_enabled": false,
  "merge_method": "merge",
  "squash_option": "default_on",
  "autoclose_referenced_issues": true,
  "enforce_auth_checks_on_uploads": true,
  "suggestion_commit_message": null,
  "merge_commit_template": null,
  "pre_receive_secret_detection_enabled": false,
  "container_registry_image_prefix": "registry.example.com/diaspora/diaspora-project-site",
  "_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",
    "cluster_agents": "http://example.com/api/v4/projects/1/cluster_agents"
  }
}

取消归档项目

取消归档一个项目。

先决条件：

您必须是管理员或被赋予项目的拥有者角色。

此端点是幂等的。取消归档一个未被归档的项目并不会改变项目。

POST /projects/:id/unarchive

支持的参数：

属性	类型	是否必需	描述
`id`	integer or string	Yes	ID 或 URL 编码的项目路径。

示例请求：

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

示例响应：

{
  "id": 3,
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
  "default_branch": "main",
  "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/main/README.md",
  "tag_list": [ //deprecated, use `topics` instead
    "example",
    "disapora project"
  ],
  "topics": [
    "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",
  "repository_object_format": "sha1",
  "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, // deprecated, use container_registry_access_level instead
  "container_registry_access_level": "disabled",
  "security_and_compliance_access_level": "disabled",
  "created_at": "2013-09-30T13:46:02Z",
  "updated_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/main/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,
  "group_runners_enabled": true,
  "forks_count": 0,
  "star_count": 0,
  "runners_token": "b8bc4a7a29eb76ea83cf79e4908c2b",
  "ci_default_git_depth": 50,
  "ci_forward_deployment_enabled": true,
  "ci_forward_deployment_rollback_allowed": true,
  "ci_allow_fork_pipelines_to_run_in_parent_project": true,
  "ci_separated_caches": true,
  "ci_restrict_pipeline_cancellation_role": "developer",
  "ci_pipeline_variables_minimum_override_role": "maintainer",
  "ci_push_repository_for_job_token_allowed": false,
  "public_jobs": true,
  "shared_with_groups": [],
  "only_allow_merge_if_pipeline_succeeds": false,
  "allow_merge_on_skipped_pipeline": false,
  "allow_pipeline_trigger_approve_deployment": false,
  "restrict_user_defined_variables": false,
  "only_allow_merge_if_all_discussions_are_resolved": false,
  "remove_source_branch_after_merge": false,
  "request_access_enabled": false,
  "merge_method": "merge",
  "squash_option": "default_on",
  "autoclose_referenced_issues": true,
  "enforce_auth_checks_on_uploads": true,
  "suggestion_commit_message": null,
  "merge_commit_template": null,
  "container_registry_image_prefix": "registry.example.com/diaspora/diaspora-project-site",
  "pre_receive_secret_detection_enabled": false,
  "_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",
    "cluster_agents": "http://example.com/api/v4/projects/1/cluster_agents"
  }
}

删除项目

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) in GitLab 13.2.-->

删除项目。此端点：

删除项目并包含所有相关的资源，包括议题和合并请求。
对专业版或旗舰版用户，会使用延迟项目删除（如启用）。
对专业版或旗舰版用户，从 GitLab 15.11 开始，如果有以下情况，则会立即删除项目：
- 项目已被标记为删除。
- 传递了 permanently_remove 和 full_path 参数。
对专业版或旗舰版用户，从 GitLab 16.0 开始，延迟项目删除默认启用。删除会在指定的天数后发生。

在 15.9 中，从管理中心的删除保护设置中立即删除项目的选项已被弃用，并在 16.0 中移除。

DELETE /projects/:id

参数	类型	是否必需	描述
`id`	integer or string	Yes	项目的 ID 或 URL 编码的路径。
`permanently_remove`	boolean/string	no	如果被标记为删除，则立即删除项目。引入于 15.11。
`full_path`	string	no	与 `permanently_remove` 一起使用的项目的完整路径。引入于 15.11。要找到项目路径，请使用获取单个项目中的 `path_with_namespace`。

恢复标记为删除的项目

恢复标记为删除的项目。

POST /projects/:id/restore

参数	类型	是否必需	描述
`id`	integer or string	Yes	项目的 ID 或 URL 编码的路径。

将项目转移到新的命名空间

将项目转移到新的命名空间。

关于转移项目的先决条件信息，可以查看转移项目至另外的命名空间。

PUT /projects/:id/transfer

支持的参数：

属性	类型	是否必需	描述
`id`	integer or string	Yes	ID 或 URL 编码的项目路径。
`namespace`	integer or string	Yes	ID 或转移的命名空间路径。

示例请求：

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/transfer?namespace=14"

示例响应：

  {
  "id": 7,
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  "description_html": "<p data-sourcepos=\"1:1-1:56\" dir=\"auto\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>",
  "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",
  "updated_at": "2020-10-15T16:25:22.415Z",
  "default_branch": "main",
  "tag_list": [], //deprecated, use `topics` instead
  "topics": [],
  "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/main/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"
  },
  "container_registry_image_prefix": "registry.example.com/cute-cats/hello-world",
  "_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, // deprecated, use container_registry_access_level instead
  "container_registry_access_level": "enabled",
  "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",
  "analytics_access_level": "enabled",
  "wiki_access_level": "enabled",
  "builds_access_level": "enabled",
  "snippets_access_level": "enabled",
  "pages_access_level": "enabled",
  "security_and_compliance_access_level": "enabled",
  "emails_disabled": null,
  "emails_enabled": null,
  "shared_runners_enabled": true,
  "group_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",
  "ci_config_path": null,
  "shared_with_groups": [],
  "only_allow_merge_if_pipeline_succeeds": false,
  "allow_merge_on_skipped_pipeline": null,
  "allow_pipeline_trigger_approve_deployment": false,
  "restrict_user_defined_variables": false,
  "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",
  "squash_option": "default_on",
  "suggestion_commit_message": null,
  "merge_commit_template": null,
  "auto_devops_enabled": true,
  "auto_devops_deploy_strategy": "continuous",
  "autoclose_referenced_issues": true,
  "approvals_before_merge": 0, // Deprecated. Use merge request approvals API instead.
  "mirror": false,
  "compliance_frameworks": [],
  "warn_about_potentially_unwanted_characters": true,
  "pre_receive_secret_detection_enabled": false
}

列出项目转移可用的群组

引入于极狐GitLab 15.4。

获取可以转移项目的群组列表。

GET /projects/:id/transfer_locations

支持的参数：

属性	类型	是否必需	描述
`id`	integer or string	Yes	ID 或 URL 编码的项目路径。
`search`	string	No	搜索的群组名称。

示例请求：

curl --request GET "https://gitlab.example.com/api/v4/projects/1/transfer_locations"

示例响应：

[
  {
    "id": 27,
    "web_url": "https://gitlab.example.com/groups/gitlab",
    "name": "GitLab",
    "avatar_url": null,
    "full_name": "GitLab",
    "full_path": "GitLab"
  },
  {
    "id": 31,
    "web_url": "https://gitlab.example.com/groups/foobar",
    "name": "FooBar",
    "avatar_url": null,
    "full_name": "FooBar",
    "full_path": "FooBar"
  }
]

上传项目头像

将头像上传到指定项目。

PUT /projects/:id

参数	类型	是否必需	描述
`id`	integer or string	Yes	项目的 ID 或 URL 编码的路径。
`avatar`	string	Yes	要上传的文件。

要从文件系统上传头像，请使用 --form 参数。这会导致 cURL 使用标头 Content-Type: multipart/form-data 发布数据。file= 参数必须指向文件系统上的图像文件，并以@ 开头。例如：

示例请求：

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

返回的对象：

{
  "avatar_url": "https://gitlab.example.com/uploads/-/system/project/avatar/2/dk.png"
}

下载项目头像

引入于极狐GitLab 16.9。

下载项目头像。如果项目是公开可访问的，则此端点的访问无需认证。

GET /projects/:id/avatar

支持的参数：

属性	类型	是否必需	描述
`id`	integer or string	yes	ID 或项目的 URL 编码路径。

示例请求：

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

移除项目头像

引入于极狐GitLab 15.4。

要移除项目头像，请在 avatar 参数中置空值。

请求示例：

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
     --data "avatar=" "https://gitlab.example.com/api/v4/projects/5"

共享项目

与群组共享项目

允许与群组共享项目。

POST /projects/:id/share

支持的参数：

参数	类型	是否必需	描述
`group_access`	integer	Yes	授予群组的角色 (`access_level`) 。
`group_id`	integer	Yes	要与之共享的群组的 ID。
`id`	integer or string	Yes	项目的 ID 或 URL 编码的路径。
`expires_at`	string	No	ISO 8601 格式的共享到期日期：2016-09-26

删除群组中的共享项目链接

从群组中取消共享项目。返回 204 并且没有成功的内容。

DELETE /projects/:id/share/:group_id

参数	类型	是否必需	描述
`group_id`	integer	Yes	群组的 ID。
`id`	integer or string	Yes	项目的 ID 或 URL 编码的路径。

示例请求：

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

开启项目的 housekeeping 任务

开启项目的 housekeeping 任务。

POST /projects/:id/housekeeping

支持的参数：

属性	类型	是否必需	描述
`id`	integer or string	Yes	ID 或 URL 编码的项目路径。
`task`	string	No	使用 `prune` 触发对不可达对象的手动清理，或使用 `eager` 触发积极的内务整理。

实时安全扫描

引入于极狐GitLab 17.6。此功是实验性的。

返回单个文件的实时 SAST 扫描结果。

POST /projects/:id/security_scans/sast/scan

支持的参数：

属性	类型	是否必需	描述
`id`	integer or string	Yes	ID 或 URL 编码的项目路径。

示例请求：

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
 --header "Content-Type: application/json" \
 --data '{
  "file_path":"src/main.c",
  "content":"#include<string.h>\nint main(int argc, char **argv) {\n  char buff[128];\n  strcpy(buff, argv[1]);\n  return 0;\n}\n"
 }' \
 --url "https://gitlab.example.com/api/v4/projects/:id/security_scans/sast/scan"

示例响应：

{
  "vulnerabilities": [
    {
      "name": "Insecure string processing function (strcpy)",
      "description": "The `strcpy` family of functions do not provide the ability to limit or check buffer\nsizes before copying to a destination buffer. This can lead to buffer overflows. Consider\nusing more secure alternatives such as `strncpy` and provide the correct limit to the\ndestination buffer and ensure the string is null terminated.\n\nFor more information please see: https://linux.die.net/man/3/strncpy\n\nIf developing for C Runtime Library (CRT), more secure versions of these functions should be\nused, see:\nhttps://learn.microsoft.com/en-us/cpp/c-runtime-library/reference/strncpy-s-strncpy-s-l-wcsncpy-s-wcsncpy-s-l-mbsncpy-s-mbsncpy-s-l?view=msvc-170\n",
      "severity": "High",
      "location": {
        "file": "src/main.c",
        "start_line": 5,
        "end_line": 5,
        "start_column": 3,
        "end_column": 23
      }
    }
  ]
}

项目徽章

在项目徽章文档中阅读更多信息。

下载 Git 仓库的快照

此端点只能由管理员用户访问。

下载项目（或 wiki，如果需要）Git 仓库的快照。此快照始终采用未压缩的 tar 格式。

如果仓库损坏到 git clone 不起作用的程度，则快照可能允许检索一些数据。

GET /projects/:id/snapshot

参数	类型	是否必需	描述
`id`	integer or string	Yes	项目的 ID 或 URL 编码的路径。
`wiki`	boolean	No	是否下载 wiki，而不是项目、仓库。

获取仓库存储的路径

如果未使用 Gitaly Cluster，则获取指定项目的仓库存储路径。

仅适用于管理员。

GET /projects/:id/storage

支持的参数：

参数	类型	是否必需	描述
`id`	integer or string	Yes	项目的 ID 或 URL 编码的路径。

[
  {
    "project_id": 1,
    "disk_path": "@hashed/6b/86/6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b",
    "created_at": "2012-10-12T17:04:47Z",
    "repository_storage": "default"
  }
]