kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss

Rodolfo Santos 1db9f826c1 Add setting to only allow merge requests to be merged when all discussions are resolved

Signed-off-by: Rémy Coutable <remy@rymai.me>

2016-11-04 14:58:40 +01:00

41 KiB

Raw Blame History

Projects

Project visibility level

Project in GitLab has be either private, internal or public. You can determine it by visibility_level field in project.

Constants for project visibility levels are next:

Private. visibility_level is 0. Project access must be granted explicitly for each user.
Internal. visibility_level is 10. The project can be cloned by any logged in user.
Public. visibility_level is 20. The project can be cloned without any authentication.

List projects

Get a list of projects for which the authenticated user is a member.

GET /projects

Parameters:

Attribute	Type	Required	Description
`archived`	boolean	no	Limit by archived status
`visibility`	string	no	Limit by visibility `public`, `internal`, or `private`
`order_by`	string	no	Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at`
`sort`	string	no	Return projects sorted in `asc` or `desc` order. Default is `desc`
`search`	string	no	Return list of authorized projects matching the search criteria
`simple`	boolean	no	Return only the ID, URL, name, and path of each project

[
  {
    "id": 4,
    "description": null,
    "default_branch": "master",
    "public": false,
    "visibility_level": 0,
    "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,
    "builds_enabled": true,
    "wiki_enabled": true,
    "snippets_enabled": false,
    "container_registry_enabled": false,
    "created_at": "2013-09-30T13:46:02Z",
    "last_activity_at": "2013-09-30T13:46:02Z",
    "creator_id": 3,
    "namespace": {
      "created_at": "2013-09-30T13:46:02Z",
      "description": "",
      "id": 3,
      "name": "Diaspora",
      "owner_id": 1,
      "path": "diaspora",
      "updated_at": "2013-09-30T13:46:02Z"
    },
    "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_builds": true,
    "shared_with_groups": [],
    "only_allow_merge_if_build_succeeds": false,
    "only_allow_merge_if_all_discussions_are_resolved": false,
    "request_access_enabled": false
  },
  {
    "id": 6,
    "description": null,
    "default_branch": "master",
    "public": false,
    "visibility_level": 0,
    "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,
    "builds_enabled": true,
    "wiki_enabled": true,
    "snippets_enabled": false,
    "container_registry_enabled": false,
    "created_at": "2013-09-30T13:46:02Z",
    "last_activity_at": "2013-09-30T13:46:02Z",
    "creator_id": 3,
    "namespace": {
      "created_at": "2013-09-30T13:46:02Z",
      "description": "",
      "id": 4,
      "name": "Brightbox",
      "owner_id": 1,
      "path": "brightbox",
      "updated_at": "2013-09-30T13:46:02Z"
    },
    "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_builds": true,
    "shared_with_groups": [],
    "only_allow_merge_if_build_succeeds": false,
    "only_allow_merge_if_all_discussions_are_resolved": false,
    "request_access_enabled": false
  }
]

Get a list of projects which the authenticated user can see.

GET /projects/visible

Parameters:

Attribute	Type	Required	Description
`archived`	boolean	no	Limit by archived status
`visibility`	string	no	Limit by visibility `public`, `internal`, or `private`
`order_by`	string	no	Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at`
`sort`	string	no	Return projects sorted in `asc` or `desc` order. Default is `desc`
`search`	string	no	Return list of authorized projects matching the search criteria
`simple`	boolean	no	Return only the ID, URL, name, and path of each project

[
  {
    "id": 4,
    "description": null,
    "default_branch": "master",
    "public": false,
    "visibility_level": 0,
    "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,
    "builds_enabled": true,
    "wiki_enabled": true,
    "snippets_enabled": false,
    "container_registry_enabled": false,
    "created_at": "2013-09-30T13:46:02Z",
    "last_activity_at": "2013-09-30T13:46:02Z",
    "creator_id": 3,
    "namespace": {
      "created_at": "2013-09-30T13:46:02Z",
      "description": "",
      "id": 3,
      "name": "Diaspora",
      "owner_id": 1,
      "path": "diaspora",
      "updated_at": "2013-09-30T13:46:02Z"
    },
    "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_builds": true,
    "shared_with_groups": []
  },
  {
    "id": 6,
    "description": null,
    "default_branch": "master",
    "public": false,
    "visibility_level": 0,
    "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,
    "builds_enabled": true,
    "wiki_enabled": true,
    "snippets_enabled": false,
    "container_registry_enabled": false,
    "created_at": "2013-09-30T13:46:02Z",
    "last_activity_at": "2013-09-30T13:46:02Z",
    "creator_id": 3,
    "namespace": {
      "created_at": "2013-09-30T13:46:02Z",
      "description": "",
      "id": 4,
      "name": "Brightbox",
      "owner_id": 1,
      "path": "brightbox",
      "updated_at": "2013-09-30T13:46:02Z"
    },
    "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_builds": true,
    "shared_with_groups": []
  }
]

List owned projects

Get a list of projects which are owned by the authenticated user.

GET /projects/owned

Parameters:

Attribute	Type	Required	Description
`archived`	boolean	no	Limit by archived status
`visibility`	string	no	Limit by visibility `public`, `internal`, or `private`
`order_by`	string	no	Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at`
`sort`	string	no	Return projects sorted in `asc` or `desc` order. Default is `desc`
`search`	string	no	Return list of authorized projects matching the search criteria

List starred projects

Get a list of projects which are starred by the authenticated user.

GET /projects/starred

Parameters:

Attribute	Type	Required	Description
`archived`	boolean	no	Limit by archived status
`visibility`	string	no	Limit by visibility `public`, `internal`, or `private`
`order_by`	string	no	Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at`
`sort`	string	no	Return projects sorted in `asc` or `desc` order. Default is `desc`
`search`	string	no	Return list of authorized projects matching the search criteria

List ALL projects

Get a list of all GitLab projects (admin only).

GET /projects/all

Parameters:

Attribute	Type	Required	Description
`archived`	boolean	no	Limit by archived status
`visibility`	string	no	Limit by visibility `public`, `internal`, or `private`
`order_by`	string	no	Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at`
`sort`	string	no	Return projects sorted in `asc` or `desc` order. Default is `desc`
`search`	string	no	Return list of authorized projects matching the search criteria

Get single project

Get a specific project, identified by project ID or NAMESPACE/PROJECT_NAME, which is owned by the authenticated user. If using namespaced projects call make sure that the NAMESPACE/PROJECT_NAME is URL-encoded, eg. /api/v3/projects/diaspora%2Fdiaspora (where / is represented by %2F).

GET /projects/:id

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or NAMESPACE/PROJECT_NAME of the project

{
  "id": 3,
  "description": null,
  "default_branch": "master",
  "public": false,
  "visibility_level": 0,
  "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,
  "builds_enabled": true,
  "wiki_enabled": true,
  "snippets_enabled": false,
  "container_registry_enabled": false,
  "created_at": "2013-09-30T13:46:02Z",
  "last_activity_at": "2013-09-30T13:46:02Z",
  "creator_id": 3,
  "namespace": {
    "created_at": "2013-09-30T13:46:02Z",
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
    "updated_at": "2013-09-30T13:46:02Z"
  },
  "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_builds": 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_build_succeeds": false,
  "only_allow_merge_if_all_discussions_are_resolved": false,
  "request_access_enabled": false
}

Get project events

Get the events for the specified project. Sorted from newest to oldest

GET /projects/:id/events

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or NAMESPACE/PROJECT_NAME of the project

[
  {
    "title": null,
    "project_id": 15,
    "action_name": "closed",
    "target_id": 830,
    "target_type": "Issue",
    "author_id": 1,
    "data": null,
    "target_title": "Public project search field",
    "author": {
      "name": "Dmitriy Zaporozhets",
      "username": "root",
      "id": 1,
      "state": "active",
      "avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
      "web_url": "http://localhost:3000/root"
    },
    "author_username": "root"
  },
  {
    "title": null,
    "project_id": 15,
    "action_name": "opened",
    "target_id": null,
    "target_type": null,
    "author_id": 1,
    "author": {
      "name": "Dmitriy Zaporozhets",
      "username": "root",
      "id": 1,
      "state": "active",
      "avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
      "web_url": "http://localhost:3000/root"
    },
    "author_username": "john",
    "data": {
      "before": "50d4420237a9de7be1304607147aec22e4a14af7",
      "after": "c5feabde2d8cd023215af4d2ceeb7a64839fc428",
      "ref": "refs/heads/master",
      "user_id": 1,
      "user_name": "Dmitriy Zaporozhets",
      "repository": {
        "name": "gitlabhq",
        "url": "git@dev.gitlab.org:gitlab/gitlabhq.git",
        "description": "GitLab: self hosted Git management software. \r\nDistributed under the MIT License.",
        "homepage": "https://dev.gitlab.org/gitlab/gitlabhq"
      },
      "commits": [
        {
          "id": "c5feabde2d8cd023215af4d2ceeb7a64839fc428",
          "message": "Add simple search to projects in public area",
          "timestamp": "2013-05-13T18:18:08+00:00",
          "url": "https://dev.gitlab.org/gitlab/gitlabhq/commit/c5feabde2d8cd023215af4d2ceeb7a64839fc428",
          "author": {
            "name": "Dmitriy Zaporozhets",
            "email": "dmitriy.zaporozhets@gmail.com"
          }
        }
      ],
      "total_commits_count": 1
    },
    "target_title": null
  },
  {
    "title": null,
    "project_id": 15,
    "action_name": "closed",
    "target_id": 840,
    "target_type": "Issue",
    "author_id": 1,
    "data": null,
    "target_title": "Finish & merge Code search PR",
    "author": {
      "name": "Dmitriy Zaporozhets",
      "username": "root",
      "id": 1,
      "state": "active",
      "avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
      "web_url": "http://localhost:3000/root"
    },
    "author_username": "root"
  },
  {
    "title": null,
    "project_id": 15,
    "action_name": "commented on",
    "target_id": 1312,
    "target_type": "Note",
    "author_id": 1,
    "data": null,
    "target_title": null,
    "created_at": "2015-12-04T10:33:58.089Z",
    "note": {
      "id": 1312,
      "body": "What an awesome day!",
      "attachment": null,
      "author": {
        "name": "Dmitriy Zaporozhets",
        "username": "root",
        "id": 1,
        "state": "active",
        "avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
        "web_url": "http://localhost:3000/root"
      },
      "created_at": "2015-12-04T10:33:56.698Z",
      "system": false,
      "upvote": false,
      "downvote": false,
      "noteable_id": 377,
      "noteable_type": "Issue"
    },
    "author": {
      "name": "Dmitriy Zaporozhets",
      "username": "root",
      "id": 1,
      "state": "active",
      "avatar_url": "http://localhost:3000/uploads/user/avatar/1/fox_avatar.png",
      "web_url": "http://localhost:3000/root"
    },
    "author_username": "root"
  }
]

Create project

Creates a new project owned by the authenticated user.

POST /projects

Parameters:

Attribute	Type	Required	Description
`name`	string	yes	The name of the new project
`path`	string	no	Custom repository name for new project. By default generated based on name
`namespace_id`	integer	no	Namespace for the new project (defaults to the current user's namespace)
`description`	string	no	Short project description
`issues_enabled`	boolean	no	Enable issues for this project
`merge_requests_enabled`	boolean	no	Enable merge requests for this project
`builds_enabled`	boolean	no	Enable builds for this project
`wiki_enabled`	boolean	no	Enable wiki for this project
`snippets_enabled`	boolean	no	Enable snippets for this project
`container_registry_enabled`	boolean	no	Enable container registry for this project
`shared_runners_enabled`	boolean	no	Enable shared runners for this project
`public`	boolean	no	If `true`, the same as setting `visibility_level` to 20
`visibility_level`	integer	no	See project visibility level
`import_url`	string	no	URL to import repository from
`public_builds`	boolean	no	If `true`, builds can be viewed by non-project-members
`only_allow_merge_if_build_succeeds`	boolean	no	Set whether merge requests can only be merged with successful builds
`only_allow_merge_if_all_discussions_are_resolved`	boolean	no	Set whether merge requests can only be merged when all the discussions are resolved
`lfs_enabled`	boolean	no	Enable LFS
`request_access_enabled`	boolean	no	Allow users to request member access

Create project for user

Creates a new project owned by the specified user. Available only for admins.

POST /projects/user/:user_id

Parameters:

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
`namespace_id`	integer	no	Namespace for the new project (defaults to the current user's namespace)
`description`	string	no	Short project description
`issues_enabled`	boolean	no	Enable issues for this project
`merge_requests_enabled`	boolean	no	Enable merge requests for this project
`builds_enabled`	boolean	no	Enable builds for this project
`wiki_enabled`	boolean	no	Enable wiki for this project
`snippets_enabled`	boolean	no	Enable snippets for this project
`container_registry_enabled`	boolean	no	Enable container registry for this project
`shared_runners_enabled`	boolean	no	Enable shared runners for this project
`public`	boolean	no	If `true`, the same as setting `visibility_level` to 20
`visibility_level`	integer	no	See project visibility level
`import_url`	string	no	URL to import repository from
`public_builds`	boolean	no	If `true`, builds can be viewed by non-project-members
`only_allow_merge_if_build_succeeds`	boolean	no	Set whether merge requests can only be merged with successful builds
`only_allow_merge_if_all_discussions_are_resolved`	boolean	no	Set whether merge requests can only be merged when all the discussions are resolved
`lfs_enabled`	boolean	no	Enable LFS
`request_access_enabled`	boolean	no	Allow users to request member access

Edit project

Updates an existing project

PUT /projects/:id

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or NAMESPACE/PROJECT_NAME 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
`description`	string	no	Short project description
`issues_enabled`	boolean	no	Enable issues for this project
`merge_requests_enabled`	boolean	no	Enable merge requests for this project
`builds_enabled`	boolean	no	Enable builds for this project
`wiki_enabled`	boolean	no	Enable wiki for this project
`snippets_enabled`	boolean	no	Enable snippets for this project
`container_registry_enabled`	boolean	no	Enable container registry for this project
`shared_runners_enabled`	boolean	no	Enable shared runners for this project
`public`	boolean	no	If `true`, the same as setting `visibility_level` to 20
`visibility_level`	integer	no	See project visibility level
`import_url`	string	no	URL to import repository from
`public_builds`	boolean	no	If `true`, builds can be viewed by non-project-members
`only_allow_merge_if_build_succeeds`	boolean	no	Set whether merge requests can only be merged with successful builds
`only_allow_merge_if_all_discussions_are_resolved`	boolean	no	Set whether merge requests can only be merged when all the discussions are resolved
`lfs_enabled`	boolean	no	Enable LFS
`request_access_enabled`	boolean	no	Allow users to request member access

On success, method returns 200 with the updated project. If parameters are invalid, 400 is returned.

Fork project

Forks a project into the user namespace of the authenticated user or the one provided.

POST /projects/fork/:id

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or NAMESPACE/PROJECT_NAME of the project
`namespace`	integer/string	yes	The ID or path of the namespace that the project will be forked to

Star a project

Stars a given project. Returns status code 201 and the project on success and 304 if the project is already starred.

POST /projects/:id/star

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or NAMESPACE/PROJECT_NAME of the project

curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/star"

Example response:

{
  "id": 3,
  "description": null,
  "default_branch": "master",
  "public": false,
  "visibility_level": 10,
  "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,
  "builds_enabled": true,
  "wiki_enabled": true,
  "snippets_enabled": false,
  "container_registry_enabled": false,
  "created_at": "2013-09-30T13:46:02Z",
  "last_activity_at": "2013-09-30T13:46:02Z",
  "creator_id": 3,
  "namespace": {
    "created_at": "2013-09-30T13:46:02Z",
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
    "updated_at": "2013-09-30T13:46:02Z"
  },
  "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_builds": true,
  "shared_with_groups": [],
  "only_allow_merge_if_build_succeeds": false,
  "only_allow_merge_if_all_discussions_are_resolved": false,
  "request_access_enabled": false
}

Unstar a project

Unstars a given project. Returns status code 200 and the project on success and 304 if the project is not starred.

DELETE /projects/:id/star

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME

curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/star"

Example response:

{
  "id": 3,
  "description": null,
  "default_branch": "master",
  "public": false,
  "visibility_level": 10,
  "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,
  "builds_enabled": true,
  "wiki_enabled": true,
  "snippets_enabled": false,
  "container_registry_enabled": false,
  "created_at": "2013-09-30T13:46:02Z",
  "last_activity_at": "2013-09-30T13:46:02Z",
  "creator_id": 3,
  "namespace": {
    "created_at": "2013-09-30T13:46:02Z",
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
    "updated_at": "2013-09-30T13:46:02Z"
  },
  "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_builds": true,
  "shared_with_groups": [],
  "only_allow_merge_if_build_succeeds": false,
  "only_allow_merge_if_all_discussions_are_resolved": false,
  "request_access_enabled": false
}

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.

Status code 201 with the project as body is given when successful, in case the user doesn't have the proper access rights, code 403 is returned. Status 404 is returned if the project doesn't exist, or is hidden to the user.

POST /projects/:id/archive

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME

curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/archive"

Example response:

{
  "id": 3,
  "description": null,
  "default_branch": "master",
  "public": false,
  "visibility_level": 0,
  "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,
  "builds_enabled": true,
  "wiki_enabled": true,
  "snippets_enabled": false,
  "container_registry_enabled": false,
  "created_at": "2013-09-30T13:46:02Z",
  "last_activity_at": "2013-09-30T13:46:02Z",
  "creator_id": 3,
  "namespace": {
    "created_at": "2013-09-30T13:46:02Z",
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
    "updated_at": "2013-09-30T13:46:02Z"
  },
  "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_builds": true,
  "shared_with_groups": [],
  "only_allow_merge_if_build_succeeds": false,
  "only_allow_merge_if_all_discussions_are_resolved": false,
  "request_access_enabled": false
}

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 an non-archived project will not change the project.

POST /projects/:id/unarchive

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME

curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/unarchive"

Example response:

{
  "id": 3,
  "description": null,
  "default_branch": "master",
  "public": false,
  "visibility_level": 0,
  "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,
  "builds_enabled": true,
  "wiki_enabled": true,
  "snippets_enabled": false,
  "container_registry_enabled": false,
  "created_at": "2013-09-30T13:46:02Z",
  "last_activity_at": "2013-09-30T13:46:02Z",
  "creator_id": 3,
  "namespace": {
    "created_at": "2013-09-30T13:46:02Z",
    "description": "",
    "id": 3,
    "name": "Diaspora",
    "owner_id": 1,
    "path": "diaspora",
    "updated_at": "2013-09-30T13:46:02Z"
  },
  "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_builds": true,
  "shared_with_groups": [],
  "only_allow_merge_if_build_succeeds": false,
  "only_allow_merge_if_all_discussions_are_resolved": false,
  "request_access_enabled": false
}

Remove project

Removes a project including all associated resources (issues, merge requests etc.)

DELETE /projects/:id

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME

Uploads

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

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME
`file`	string	yes	The file to be uploaded

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

Note: The returned url is relative to the project path. In Markdown contexts, the link is automatically expanded when the format in markdown is used.

Project members

Please consult the Project Members documentation.

Allow to share project with group.

POST /projects/:id/share

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME
`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

Hooks

Also called Project Hooks and Webhooks. These are different for System Hooks that are system wide.

List project hooks

Get a list of project hooks.

GET /projects/:id/hooks

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME

Get project hook

Get a specific hook for a project.

GET /projects/:id/hooks/:hook_id

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME
`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,
  "merge_requests_events": true,
  "tag_push_events": true,
  "note_events": true,
  "build_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

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME
`url`	string	yes	The hook URL
`push_events`	boolean	no	Trigger hook on push events
`issues_events`	boolean	no	Trigger hook on 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
`build_events`	boolean	no	Trigger hook on build 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

Edit project hook

Edits a hook for a specified project.

PUT /projects/:id/hooks/:hook_id

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME
`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
`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
`build_events`	boolean	no	Trigger hook on build 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

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME
`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.

Branches

For more information please consult the Branches documentation.

List branches

Lists all branches of a project.

GET /projects/:id/repository/branches

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME

[
  {
    "name": "async",
    "commit": {
      "id": "a2b702edecdf41f07b42653eb1abe30ce98b9fca",
      "parent_ids": [
        "3f94fc7c85061973edc9906ae170cc269b07ca55"
      ],
      "message": "give Caolan credit where it's due (up top)",
      "author_name": "Jeremy Ashkenas",
      "author_email": "jashkenas@example.com",
      "authored_date": "2010-12-08T21:28:50+00:00",
      "committer_name": "Jeremy Ashkenas",
      "committer_email": "jashkenas@example.com",
      "committed_date": "2010-12-08T21:28:50+00:00"
    },
    "protected": false,
    "developers_can_push": false,
    "developers_can_merge": false
  },
  {
    "name": "gh-pages",
    "commit": {
      "id": "101c10a60019fe870d21868835f65c25d64968fc",
      "parent_ids": [
          "9c15d2e26945a665131af5d7b6d30a06ba338aaa"
      ],
      "message": "Underscore.js 1.5.2",
      "author_name": "Jeremy Ashkenas",
      "author_email": "jashkenas@example.com",
      "authored_date": "2013-09-07T12:58:21+00:00",
      "committer_name": "Jeremy Ashkenas",
      "committer_email": "jashkenas@example.com",
      "committed_date": "2013-09-07T12:58:21+00:00"
    },
    "protected": false,
    "developers_can_push": false,
    "developers_can_merge": false
  }
]

Single branch

A specific branch of a project.

GET /projects/:id/repository/branches/:branch

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME
`branch`	string	yes	The name of the branch
`developers_can_push`	boolean	no	Flag if developers can push to the branch
`developers_can_merge`	boolean	no	Flag if developers can merge to the branch

Protect single branch

Protects a single branch of a project.

PUT /projects/:id/repository/branches/:branch/protect

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME
`branch`	string	yes	The name of the branch

Unprotect single branch

Unprotects a single branch of a project.

PUT /projects/:id/repository/branches/:branch/unprotect

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME
`branch`	string	yes	The name of the branch

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

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME
`forked_from_id`	ID	yes	The ID of the project that was forked from

Delete an existing forked from relationship

DELETE /projects/:id/fork

Parameter:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID of the project or NAMESPACE/PROJECT_NAME

Search for projects by name

Search for projects by name which are accessible to the authenticated user.

GET /projects/search/:query

Parameters:

Attribute	Type	Required	Description
`query`	string	yes	A string contained in the project name
`order_by`	string	no	Return requests ordered by `id`, `name`, `created_at` or `last_activity_at` fields
`sort`	string	no	Return requests sorted in `asc` or `desc` order

41 KiB Raw Blame History

Projects

Project visibility level

List projects

List owned projects

List starred projects

List ALL projects

Get single project

Get project events

Create project

Create project for user

Edit project

Fork project

Star a project

Unstar a project

Archive a project

Unarchive a project

Remove project

Uploads

Upload a file

Project members

Share project with group

Hooks

List project hooks

Get project hook

Add project hook

Edit project hook

Delete project hook

Branches

List branches

Single branch

Protect single branch

Unprotect single branch

Admin fork relation

Create a forked from/to relation between existing projects.

Delete an existing forked from relationship

Search for projects by name

41 KiB

Raw Blame History