Projects API
Project visibility level
Project in GitLab can be either private, internal or public. This is determined by thevisibilityfield in the project.
Values for the project visibility level are:
private: Project access must be granted explicitly for each user.internal: The project can be cloned by any logged in user.public: The project can be cloned without any authentication.
Project merge method
There are currently three options formerge_methodto choose from:
merge: A merge commit is created for every merge, and merging is allowed as long as there are no conflicts.rebase_merge: A merge commit is created for every merge, but merging is only allowed if fast-forward merge is possible. This way you could make sure that if this merge request would build, after merging to target branch it would also build.ff: No merge commits are created and all merges are fast-forwarded, which means that merging is only allowed if the branch could be fast-forwarded.
List all projects
Get a list of all visible projects across GitLab for the authenticated user. When accessed without authentication, only public projects are returned.
GET /projects| Attribute | Type | Required | Description |
|---|---|---|---|
archived |
boolean | no | Limit by archived status |
visibility |
string | no | Limit by visibilitypublic,internal, orprivate |
order_by |
string | no | Return projects ordered byid,name,path,created_at,updated_at, orlast_activity_atfields. Default iscreated_at |
sort |
string | no | Return projects sorted inascordescorder. Default isdesc |
search |
string | no | Return list of projects matching the search criteria |
simple |
boolean | no | Return only the ID, URL, name, and path of each project |
owned |
boolean | no | Limit by projects owned by the current user |
membership |
boolean | no | Limit by projects that the current user is a member of |
starred |
boolean | no | Limit by projects starred by the current user |
statistics |
boolean | no | Include project statistics |
with_custom_attributes |
boolean | no | Includecustom attributesin response (admins only) |
with_issues_enabled |
boolean | no | Limit by enabled issues feature |
with_merge_requests_enabled |
boolean | no | Limit by enabled merge requests feature |
[{"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","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,"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,"only_allow_merge_if_all_discussions_are_resolved":false,"request_access_enabled":false,"merge_method":"merge","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","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,"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,"only_allow_merge_if_all_discussions_are_resolved":false,"request_access_enabled":false,"merge_method":"merge","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"}}]You can filter bycustom attributeswith:
GET /projects?custom_attributes[key]=value&custom_attributes[other_key]=other_valueList user projects
Get a list of visible projects for the given user. When accessed without authentication, only public projects are returned.
GET /users/:user_id/projects| Attribute | Type | Required | Description |
|---|---|---|---|
user_id |
string | yes | The ID or username of the user |
archived |
boolean | no | Limit by archived status |
visibility |
string | no | Limit by visibilitypublic,internal, orprivate |
order_by |
string | no | Return projects ordered byid,name,path,created_at,updated_at, orlast_activity_atfields. Default iscreated_at |
sort |
string | no | Return projects sorted inascordescorder. Default isdesc |
search |
string | no | Return list of projects matching the search criteria |
simple |
boolean | no | Return only the ID, URL, name, and path of each project |
owned |
boolean | no | Limit by projects owned by the current user |
membership |
boolean | no | Limit by projects that the current user is a member of |
starred |
boolean | no | Limit by projects starred by the current user |
statistics |
boolean | no | Include project statistics |
with_custom_attributes |
boolean | no | Includecustom attributesin response (admins only) |
with_issues_enabled |
boolean | no | Limit by enabled issues feature |
with_merge_requests_enabled |
boolean | no | Limit by enabled merge requests feature |
[{"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","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,"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,"only_allow_merge_if_all_discussions_are_resolved":false,"request_access_enabled":false,"merge_method":"merge","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","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,"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,"only_allow_merge_if_all_discussions_are_resolved":false,"request_access_enabled":false,"merge_method":"merge","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 a specific project. This endpoint can be accessed without authentication if the project is publicly accessible.
GET /projects/:id| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
statistics |
boolean | no | Include project statistics |
with_custom_attributes |
boolean | no | Includecustom attributesin response (admins only) |
{"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","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,"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","shared_runners_enabled":true,"forks_count":0,"star_count":0,"runners_token":"b8bc4a7a29eb76ea83cf79e4908c2b","public_jobs":true,"shared_with_groups":[{"group_id":4,"group_name":"Twitter","group_access_level":30},{"group_id":3,"group_name":"Gitlab Org","group_access_level":10}],"only_allow_merge_if_pipeline_succeeds":false,"only_allow_merge_if_all_discussions_are_resolved":false,"printing_merge_requests_link_enabled":true,"request_access_enabled":false,"merge_method":"merge","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"}}Get project users
Get the users list of a project.
GET /projects/:id/users| Attribute | Type | Required | Description |
|---|---|---|---|
search |
string | no | Search for specific 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
Please refer to theEvents API documentation.
Create project
Creates a new project owned by the authenticated user.
POST /projects| Attribute | Type | Required | Description |
|---|---|---|---|
name |
string | yes if path is not provided | The name of the new project. Equals path if not provided. |
path |
string | yes if name is not provided | Repository name for new project. Generated based on name if not provided (generated lowercased with dashes). |
namespace_id |
integer | no | Namespace for the new project (defaults to the current user's namespace) |
描述 |
string | no | Short project description |
issues_enabled |
boolean | no | Enable issues for this project |
merge_requests_enabled |
boolean | no | Enable merge requests for this project |
jobs_enabled |
boolean | no | Enable jobs for this project |
wiki_enabled |
boolean | no | Enable wiki for this project |
snippets_enabled |
boolean | no | Enable snippets for this project |
resolve_outdated_diff_discussions |
boolean | no | Automatically resolve merge request diffs discussions on lines changed with a push |
container_registry_enabled |
boolean | no | Enable container registry for this project |
shared_runners_enabled |
boolean | no | Enable shared runners for this project |
visibility |
string | no | Seeproject visibility level |
import_url |
string | no | URL to import repository from |
public_jobs |
boolean | no | Iftrue, jobs can be viewed by non-project-members |
只有_allow_merge_if_pipeline_succeeds |
boolean | no | Set whether merge requests can only be merged with successful jobs |
只有_allow_merge_if_all_discussions_are_resolved |
boolean | no | Set whether merge requests can only be merged when all the discussions are resolved |
merge_method |
string | no | Set the merge method used |
lfs_enabled |
boolean | no | Enable LFS |
request_access_enabled |
boolean | no | Allow users to request member access |
tag_list |
array | no | The list of tags for a project; put array of tags, that should be finally assigned to a project |
avatar |
mixed | no | Image file for avatar of the project |
printing_merge_request_link_enabled |
boolean | no | Show link to create/view merge request when pushing from the command line |
ci_config_path |
string | no | The path to CI config file |
Create project for user
Creates a new project owned by the specified user. Available only for admins.
POST /projects/user/:user_id| Attribute | Type | Required | Description |
|---|---|---|---|
user_id |
integer | yes | The user ID of the project owner |
name |
string | yes | The name of the new project |
path |
string | no | Custom repository name for new project. By default generated based on name |
default_branch |
string | no | masterby default |
namespace_id |
integer | no | Namespace for the new project (defaults to the current user's namespace) |
描述 |
string | no | Short project description |
issues_enabled |
boolean | no | Enable issues for this project |
merge_requests_enabled |
boolean | no | Enable merge requests for this project |
jobs_enabled |
boolean | no | Enable jobs for this project |
wiki_enabled |
boolean | no | Enable wiki for this project |
snippets_enabled |
boolean | no | Enable snippets for this project |
resolve_outdated_diff_discussions |
boolean | no | Automatically resolve merge request diffs discussions on lines changed with a push |
container_registry_enabled |
boolean | no | Enable container registry for this project |
shared_runners_enabled |
boolean | no | Enable shared runners for this project |
visibility |
string | no | Seeproject visibility level |
import_url |
string | no | URL to import repository from |
public_jobs |
boolean | no | Iftrue, jobs can be viewed by non-project-members |
只有_allow_merge_if_pipeline_succeeds |
boolean | no | Set whether merge requests can only be merged with successful jobs |
只有_allow_merge_if_all_discussions_are_resolved |
boolean | no | Set whether merge requests can only be merged when all the discussions are resolved |
merge_method |
string | no | Set the merge method used |
lfs_enabled |
boolean | no | Enable LFS |
request_access_enabled |
boolean | no | Allow users to request member access |
tag_list |
array | no | The list of tags for a project; put array of tags, that should be finally assigned to a project |
avatar |
mixed | no | Image file for avatar of the project |
printing_merge_request_link_enabled |
boolean | no | Show link to create/view merge request when pushing from the command line |
ci_config_path |
string | no | The path to CI config file |
Edit project
Updates an existing project.
PUT /projects/:id| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
name |
string | yes | The name of the project |
path |
string | no | Custom repository name for the project. By default generated based on name |
default_branch |
string | no | masterby default |
描述 |
string | no | Short project description |
issues_enabled |
boolean | no | Enable issues for this project |
merge_requests_enabled |
boolean | no | Enable merge requests for this project |
jobs_enabled |
boolean | no | Enable jobs for this project |
wiki_enabled |
boolean | no | Enable wiki for this project |
snippets_enabled |
boolean | no | Enable snippets for this project |
resolve_outdated_diff_discussions |
boolean | no | Automatically resolve merge request diffs discussions on lines changed with a push |
container_registry_enabled |
boolean | no | Enable container registry for this project |
shared_runners_enabled |
boolean | no | Enable shared runners for this project |
visibility |
string | no | Seeproject visibility level |
import_url |
string | no | URL to import repository from |
public_jobs |
boolean | no | Iftrue, jobs can be viewed by non-project-members |
只有_allow_merge_if_pipeline_succeeds |
boolean | no | Set whether merge requests can only be merged with successful jobs |
只有_allow_merge_if_all_discussions_are_resolved |
boolean | no | Set whether merge requests can only be merged when all the discussions are resolved |
merge_method |
string | no | Set the merge method used |
lfs_enabled |
boolean | no | Enable LFS |
request_access_enabled |
boolean | no | Allow users to request member access |
tag_list |
array | no | The list of tags for a project; put array of tags, that should be finally assigned to a project |
avatar |
mixed | no | Image file for avatar of the project |
ci_config_path |
string | no | The path to CI config file |
Fork project
Forks a project into the user namespace of the authenticated user or the one provided.
The forking operation for a project is asynchronous and is completed in a background job. The request will return immediately. To determine whether the fork of the project has completed, query theimport_statusfor the new project.
POST /projects/:id/fork| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
namespace |
integer/string | yes | The ID or path of the namespace that the project will be forked to |
List Forks of a project
Note:This feature was introduced in GitLab 10.1
List the projects accessible to the calling user that have an established, forked relationship with the specified project
GET /projects/:id/forks| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
archived |
boolean | no | Limit by archived status |
visibility |
string | no | Limit by visibilitypublic,internal, orprivate |
order_by |
string | no | Return projects ordered byid,name,path,created_at,updated_at, orlast_activity_atfields. Default iscreated_at |
sort |
string | no | Return projects sorted inascordescorder. Default isdesc |
search |
string | no | Return list of projects matching the search criteria |
simple |
boolean | no | Return only the ID, URL, name, and path of each project |
owned |
boolean | no | Limit by projects owned by the current user |
membership |
boolean | no | Limit by projects that the current user is a member of |
starred |
boolean | no | Limit by projects starred by the current user |
statistics |
boolean | no | Include project statistics |
with_custom_attributes |
boolean | no | Includecustom attributesin response (admins only) |
with_issues_enabled |
boolean | no | Limit by enabled issues feature |
with_merge_requests_enabled |
boolean | no | Limit by enabled merge requests feature |
curl--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK""https://gitlab.example.com/api/v4/projects/5/forks"Example responses:
[{"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","tag_list":["example","disapora project"],"name":"Diaspora Project Site","name_with_namespace":"Diaspora / Diaspora Project Site","path":"diaspora-project-site","path_with_namespace":"diaspora/diaspora-project-site","issues_enabled":true,"open_issues_count":1,"merge_requests_enabled":true,"jobs_enabled":true,"wiki_enabled":true,"snippets_enabled":false,"resolve_outdated_diff_discussions":false,"container_registry_enabled":false,"created_at":"2013-09-30T13:46:02Z","last_activity_at":"2013-09-30T13:46:02Z","creator_id":3,"namespace":{"id":3,"name":"Diaspora","path":"diaspora","kind":"group","full_path":"diaspora"},"import_status":"none","archived":true,"avatar_url":"http://example.com/uploads/project/avatar/3/uploads/avatar.png","shared_runners_enabled":true,"forks_count":0,"star_count":1,"public_jobs":true,"shared_with_groups":[],"only_allow_merge_if_pipeline_succeeds":false,"only_allow_merge_if_all_discussions_are_resolved":false,"request_access_enabled":false,"merge_method":"merge","_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
Stars a given project. Returns status code304if the project is already starred.
POST /projects/:id/star| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
curl--requestPOST--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK""https://gitlab.example.com/api/v4/projects/5/star"Example response:
{"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","tag_list":["example","disapora project"],"name":"Diaspora Project Site","name_with_namespace":"Diaspora / Diaspora Project Site","path":"diaspora-project-site","path_with_namespace":"diaspora/diaspora-project-site","issues_enabled":true,"open_issues_count":1,"merge_requests_enabled":true,"jobs_enabled":true,"wiki_enabled":true,"snippets_enabled":false,"resolve_outdated_diff_discussions":false,"container_registry_enabled":false,"created_at":"2013-09-30T13:46:02Z","last_activity_at":"2013-09-30T13:46:02Z","creator_id":3,"namespace":{"id":3,"name":"Diaspora","path":"diaspora","kind":"group","full_path":"diaspora"},"import_status":"none","archived":true,"avatar_url":"http://example.com/uploads/project/avatar/3/uploads/avatar.png","shared_runners_enabled":true,"forks_count":0,"star_count":1,"public_jobs":true,"shared_with_groups":[],"only_allow_merge_if_pipeline_succeeds":false,"only_allow_merge_if_all_discussions_are_resolved":false,"request_access_enabled":false,"merge_method":"merge","_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
Unstars a given project. Returns status code304if the project is not starred.
POST /projects/:id/unstar| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
curl--requestPOST--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK""https://gitlab.example.com/api/v4/projects/5/unstar"Example response:
{"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","tag_list":["example","disapora project"],"name":"Diaspora Project Site","name_with_namespace":"Diaspora / Diaspora Project Site","path":"diaspora-project-site","path_with_namespace":"diaspora/diaspora-project-site","issues_enabled":true,"open_issues_count":1,"merge_requests_enabled":true,"jobs_enabled":true,"wiki_enabled":true,"snippets_enabled":false,"resolve_outdated_diff_discussions":false,"container_registry_enabled":false,"created_at":"2013-09-30T13:46:02Z","last_activity_at":"2013-09-30T13:46:02Z","creator_id":3,"namespace":{"id":3,"name":"Diaspora","path":"diaspora","kind":"group","full_path":"diaspora"},"import_status":"none","archived":true,"avatar_url":"http://example.com/uploads/project/avatar/3/uploads/avatar.png","shared_runners_enabled":true,"forks_count":0,"star_count":0,"public_jobs":true,"shared_with_groups":[],"only_allow_merge_if_pipeline_succeeds":false,"only_allow_merge_if_all_discussions_are_resolved":false,"request_access_enabled":false,"merge_method":"merge","_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"}}Languages
Get languages used in a project with percentage value.
GET /projects/:id/languagescurl--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK""https://gitlab.example.com/api/v4/projects/5/languages"Example response:
{"Ruby":66.69,"JavaScript":22.98,"HTML":7.91,"CoffeeScript":2.42}Archive a project
Archives the project if the user is either admin or the project owner of this project. This action is idempotent, thus archiving an already archived project will not change the project.
POST /projects/:id/archive| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
curl--requestPOST--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK""https://gitlab.example.com/api/v4/projects/5/archive"Example response:
{"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","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,"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","shared_runners_enabled":true,"forks_count":0,"star_count":0,"runners_token":"b8bc4a7a29eb76ea83cf79e4908c2b","public_jobs":true,"shared_with_groups":[],"only_allow_merge_if_pipeline_succeeds":false,"only_allow_merge_if_all_discussions_are_resolved":false,"request_access_enabled":false,"merge_method":"merge","_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
Unarchives the project if the user is either admin or the project owner of this project. This action is idempotent, thus unarchiving a non-archived project will not change the project.
POST /projects/:id/unarchive| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
curl--requestPOST--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK""https://gitlab.example.com/api/v4/projects/5/unarchive"Example response:
{"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","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,"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","shared_runners_enabled":true,"forks_count":0,"star_count":0,"runners_token":"b8bc4a7a29eb76ea83cf79e4908c2b","public_jobs":true,"shared_with_groups":[],"only_allow_merge_if_pipeline_succeeds":false,"only_allow_merge_if_all_discussions_are_resolved":false,"request_access_enabled":false,"merge_method":"merge","_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
Removes a project including all associated resources (issues, merge requests etc.)
DELETE /projects/:id| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
Upload a file
Uploads a file to the specified project to be used in an issue or merge request description, or a comment.
POST /projects/:id/uploads| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
file |
string | yes | The file to be uploaded |
To upload a file from your filesystem, use the--formargument. This causes cURL to post data using the headerContent-Type: multipart/form-data. Thefile=parameter must point to a file on your filesystem and be preceded by@. For example:
curl--requestPOST--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"--form"file=@dk.png"https://gitlab.example.com/api/v3/projects/5/uploadsReturned object:
{"alt":"dk","url":"/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png","markdown":""}Note: The returned
urlis relative to the project path. In Markdown contexts, the link is automatically expanded when the format inmarkdownis used.
Share project with group
Allow to share project with group.
POST /projects/:id/share| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
group_id |
integer | yes | The ID of the group to share with |
group_access |
integer | yes | The permissions level to grant the group |
expires_at |
string | no | Share expiration date in ISO 8601 format: 2016-09-26 |
Delete a shared project link within a group
Unshare the project from the group. Returns204and no content on success.
DELETE /projects/:id/share/:group_id| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
group_id |
integer | yes | The ID of the group |
curl--requestDELETE--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"https://gitlab.example.com/api/v4/projects/5/share/17Hooks
Also called Project Hooks and Webhooks. These are different forSystem Hooksthat are system wide.
List project hooks
Get a list of project hooks.
/项目/:id /挂钩| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
Get project hook
Get a specific hook for a project.
/项目/:id /挂钩/:hook_id| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
hook_id |
integer | yes | The ID of a project hook |
{"id":1,"url":"http://example.com/hook","project_id":3,"push_events":true,"issues_events":true,"confidential_issues_events":true,"merge_requests_events":true,"tag_push_events":true,"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
Adds a hook to a specified project.
POST /projects/:id/hooks| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
url |
string | yes | The hook URL |
push_events |
boolean | no | Trigger hook on push events |
issues_events |
boolean | no | Trigger hook on issues events |
confidential_issues_events |
boolean | no | Trigger hook on confidential issues events |
merge_requests_events |
boolean | no | Trigger hook on merge requests events |
tag_push_events |
boolean | no | Trigger hook on tag push events |
note_events |
boolean | no | Trigger hook on note events |
job_events |
boolean | no | Trigger hook on job events |
pipeline_events |
boolean | no | Trigger hook on pipeline events |
wiki_page_events |
boolean | no | Trigger hook on wiki events |
enable_ssl_verification |
boolean | no | Do SSL verification when triggering the hook |
token |
string | no | Secret token to validate received payloads; this will not be returned in the response |
Edit project hook
Edits a hook for a specified project.
PUT /projects/:id/hooks/:hook_id| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
hook_id |
integer | yes | The ID of the project hook |
url |
string | yes | The hook URL |
push_events |
boolean | no | Trigger hook on push events |
issues_events |
boolean | no | Trigger hook on issues events |
confidential_issues_events |
boolean | no | Trigger hook on confidential issues events |
merge_requests_events |
boolean | no | Trigger hook on merge requests events |
tag_push_events |
boolean | no | Trigger hook on tag push events |
note_events |
boolean | no | Trigger hook on note events |
job_events |
boolean | no | Trigger hook on job events |
pipeline_events |
boolean | no | Trigger hook on pipeline events |
wiki_events |
boolean | no | Trigger hook on wiki events |
enable_ssl_verification |
boolean | no | Do SSL verification when triggering the hook |
token |
string | no | Secret token to validate received payloads; this will not be returned in the response |
Delete project hook
Removes a hook from a project. This is an idempotent method and can be called multiple times. Either the hook is available or not.
DELETE /projects/:id/hooks/:hook_id| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
hook_id |
integer | yes | The ID of the project hook |
Note the JSON response differs if the hook is available or not. If the project hook is available before it is returned in the JSON response or an empty response is returned.
Admin fork relation
Allows modification of the forked relationship between existing projects. Available only for admins.
Create a forked from/to relation between existing projects
POST /projects/:id/fork/:forked_from_id| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
forked_from_id |
ID | yes | The ID of the project that was forked from |
Delete an existing forked from relationship
DELETE /projects/:id/fork| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
Search for projects by name
Search for projects by name which are accessible to the authenticated user. This endpoint can be accessed without authentication if the project is publicly accessible.
GET /projects| Attribute | Type | Required | Description |
|---|---|---|---|
search |
string | yes | A string contained in the project name |
order_by |
string | no | 返回请求命令id,name,created_atorlast_activity_atfields |
sort |
string | no | Return requests sorted inascordescorder |
curl--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"https://gitlab.example.com/api/v4/projects?search=testStart the Housekeeping task for a Project
Introduced in GitLab 9.0.
POST /projects/:id/housekeeping| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
Branches
Read more in theBranchesdocumentation.
Project Import/Export
Read more in theProject import/exportdocumentation.
Project members
Read more in theProject membersdocumentation.
Project badges
Read more in theProject Badgesdocumentation.
Issue and merge request description templates
The non-defaultissue and merge request description templates管理在项目的存储库。所以哟u can manage them via the API through theRepositories APIand theRepository Files API.
Download snapshot of a git repository
Introduced in GitLab 10.7
This endpoint may only be accessed by an administrative user.
Download a snapshot of the project (or wiki, if requested) git repository. This snapshot is always in uncompressedtarformat.
If a repository is corrupted to the point wheregit clonedoes not work, the snapshot may allow some of the data to be retrieved.
GET /projects/:id/snapshot| Attribute | Type | Required | Description |
|---|---|---|---|
id |
integer/string | yes | The ID orURL-encoded path of the project |
wiki |
boolean | no | Whether to download the wiki, rather than project, repository |