2014-05-27 12:12:15 +00:00
# Projects
2013-02-14 19:43:48 +00:00
2015-02-20 18:27:37 +00:00
### Project visibility level
Project in GitLab has be either private, internal or public.
2015-07-08 20:27:36 +00:00
You can determine it by `visibility_level` field in project.
2015-02-20 18:27:37 +00:00
Constants for project visibility levels are next:
2015-07-08 20:27:36 +00:00
* Private. `visibility_level` is `0` .
2015-02-20 18:27:37 +00:00
Project access must be granted explicitly for each user.
* Internal. `visibility_level` is `10` .
The project can be cloned by any logged in user.
2015-07-08 20:27:36 +00:00
2015-02-20 18:27:37 +00:00
* Public. `visibility_level` is `20` .
The project can be cloned without any authentication.
2014-08-15 06:54:50 +00:00
## List projects
2012-07-05 13:57:45 +00:00
2013-11-18 17:53:10 +00:00
Get a list of projects accessible by the authenticated user.
2012-07-05 13:57:45 +00:00
```
GET /projects
```
2014-07-28 05:01:01 +00:00
Parameters:
2014-08-15 06:54:50 +00:00
- `archived` (optional) - if passed, limit by archived status
2016-01-13 14:07:21 +00:00
- `public` (optional) - if passed, limit by public visibility
2015-02-06 06:00:54 +00:00
- `order_by` (optional) - Return requests ordered by `id` , `name` , `path` , `created_at` , `updated_at` or `last_activity_at` fields. Default is `created_at`
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
2015-01-12 10:08:53 +00:00
- `search` (optional) - Return list of authorized projects according to a search criteria
2014-07-28 05:01:01 +00:00
2012-07-05 13:57:45 +00:00
```json
[
{
2013-10-01 21:13:09 +00:00
"id": 4,
2012-07-05 13:57:45 +00:00
"description": null,
"default_branch": "master",
2013-10-01 21:13:09 +00:00
"public": false,
2013-11-06 15:13:21 +00:00
"visibility_level": 0,
2013-10-01 21:13:09 +00:00
"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",
2015-02-05 01:42:34 +00:00
"tag_list": [
"example",
"disapora client"
],
2012-07-05 13:57:45 +00:00
"owner": {
2013-10-01 21:13:09 +00:00
"id": 3,
"name": "Diaspora",
"created_at": "2013-09-30T13: 46: 02Z"
2012-07-05 13:57:45 +00:00
},
2013-10-01 21:13:09 +00:00
"name": "Diaspora Client",
"name_with_namespace": "Diaspora / Diaspora Client",
"path": "diaspora-client",
"path_with_namespace": "diaspora/diaspora-client",
"issues_enabled": true,
2015-12-12 07:17:36 +00:00
"open_issues_count": 1,
2013-10-01 21:13:09 +00:00
"merge_requests_enabled": true,
2015-11-09 15:48:03 +00:00
"builds_enabled": true,
2012-07-05 13:57:45 +00:00
"wiki_enabled": true,
2013-10-01 21:13:09 +00:00
"snippets_enabled": false,
"created_at": "2013-09-30T13: 46: 02Z",
"last_activity_at": "2013-09-30T13: 46: 02Z",
2015-04-10 18:05:01 +00:00
"creator_id": 3,
2013-10-01 21:13:09 +00:00
"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"
2014-04-20 10:01:55 +00:00
},
2015-02-28 17:07:53 +00:00
"archived": false,
2016-01-07 09:39:02 +00:00
"avatar_url": "http://example.com/uploads/project/avatar/4/uploads/avatar.png",
"shared_runners_enabled": true,
"forks_count": 0,
2016-01-11 14:27:20 +00:00
"star_count": 0
2012-07-05 13:57:45 +00:00
},
{
2013-10-01 21:13:09 +00:00
"id": 6,
2012-07-05 13:57:45 +00:00
"description": null,
2013-10-01 21:13:09 +00:00
"default_branch": "master",
"public": false,
2013-11-06 15:13:21 +00:00
"visibility_level": 0,
2013-10-01 21:13:09 +00:00
"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",
2015-02-05 01:42:34 +00:00
"tag_list": [
"example",
"puppet"
],
2014-04-05 06:36:47 +00:00
"owner": {
2013-10-01 21:13:09 +00:00
"id": 4,
"name": "Brightbox",
"created_at": "2013-09-30T13:46:02Z"
2012-07-05 13:57:45 +00:00
},
2013-10-01 21:13:09 +00:00
"name": "Puppet",
"name_with_namespace": "Brightbox / Puppet",
"path": "puppet",
"path_with_namespace": "brightbox/puppet",
2012-07-05 13:57:45 +00:00
"issues_enabled": true,
2015-12-12 07:17:36 +00:00
"open_issues_count": 1,
2012-07-05 13:57:45 +00:00
"merge_requests_enabled": true,
2015-11-09 15:48:03 +00:00
"builds_enabled": true,
2012-07-05 13:57:45 +00:00
"wiki_enabled": true,
2013-10-01 21:13:09 +00:00
"snippets_enabled": false,
"created_at": "2013-09-30T13:46:02Z",
"last_activity_at": "2013-09-30T13:46:02Z",
2015-04-10 18:05:01 +00:00
"creator_id": 3,
2014-04-05 06:36:47 +00:00
"namespace": {
2013-10-01 21:13:09 +00:00
"created_at": "2013-09-30T13:46:02Z",
"description": "",
"id": 4,
"name": "Brightbox",
"owner_id": 1,
"path": "brightbox",
"updated_at": "2013-09-30T13:46:02Z"
2014-04-20 10:01:55 +00:00
},
2015-12-13 19:43:17 +00:00
"permissions": {
"project_access": {
"access_level": 10,
"notification_level": 3
},
"group_access": {
"access_level": 50,
"notification_level": 3
}
},
2015-02-28 17:07:53 +00:00
"archived": false,
2016-01-07 09:39:02 +00:00
"avatar_url": null,
"shared_runners_enabled": true,
"forks_count": 0,
"star_count": 0,
"runners_token": "b8547b1dc37721d05889db52fa2f02"
2012-07-05 13:57:45 +00:00
}
]
```
2014-08-15 06:54:50 +00:00
### List owned projects
2013-11-18 14:49:29 +00:00
2014-07-31 16:39:04 +00:00
Get a list of projects which are owned by the authenticated user.
2013-11-18 14:49:29 +00:00
```
GET /projects/owned
```
2015-02-06 06:00:54 +00:00
Parameters:
- `archived` (optional) - if passed, limit by archived status
- `order_by` (optional) - Return requests ordered by `id` , `name` , `path` , `created_at` , `updated_at` or `last_activity_at` fields. Default is `created_at`
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
2015-12-16 20:39:27 +00:00
- `search` (optional) - Return list of authorized projects according to a search criteria
### List starred projects
Get a list of projects which are starred by the authenticated user.
```
GET /projects/starred
```
Parameters:
- `archived` (optional) - if passed, limit by archived status
- `order_by` (optional) - Return requests ordered by `id` , `name` , `path` , `created_at` , `updated_at` or `last_activity_at` fields. Default is `created_at`
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
2015-02-06 06:00:54 +00:00
- `search` (optional) - Return list of authorized projects according to a search criteria
2014-08-15 06:54:50 +00:00
### List ALL projects
2013-11-18 14:49:29 +00:00
Get a list of all GitLab projects (admin only).
```
GET /projects/all
```
2015-02-06 06:00:54 +00:00
Parameters:
- `archived` (optional) - if passed, limit by archived status
- `order_by` (optional) - Return requests ordered by `id` , `name` , `path` , `created_at` , `updated_at` or `last_activity_at` fields. Default is `created_at`
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
- `search` (optional) - Return list of authorized projects according to a search criteria
2013-02-14 19:43:48 +00:00
### Get single project
2012-07-05 13:57:45 +00:00
2014-07-31 16:39:04 +00:00
Get a specific project, identified by project ID or NAMESPACE/PROJECT_NAME, which is owned by the authenticated user.
2013-10-18 07:11:37 +00:00
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` ).
2012-07-05 13:57:45 +00:00
```
GET /projects/:id
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
2012-07-05 13:57:45 +00:00
2012-08-31 07:25:36 +00:00
```json
{
2013-10-01 21:13:09 +00:00
"id": 3,
2012-08-31 07:25:36 +00:00
"description": null,
2013-10-01 21:13:09 +00:00
"default_branch": "master",
"public": false,
2013-11-06 15:13:21 +00:00
"visibility_level": 0,
2013-10-01 21:13:09 +00:00
"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",
2015-02-05 01:42:34 +00:00
"tag_list": [
"example",
"disapora project"
],
2012-08-31 07:25:36 +00:00
"owner": {
2013-10-01 21:13:09 +00:00
"id": 3,
"name": "Diaspora",
"created_at": "2013-09-30T13: 46: 02Z"
2012-08-31 07:25:36 +00:00
},
2013-10-01 21:13:09 +00:00
"name": "Diaspora Project Site",
"name_with_namespace": "Diaspora / Diaspora Project Site",
"path": "diaspora-project-site",
"path_with_namespace": "diaspora/diaspora-project-site",
2012-08-31 07:25:36 +00:00
"issues_enabled": true,
2015-12-12 07:17:36 +00:00
"open_issues_count": 1,
2012-08-31 07:25:36 +00:00
"merge_requests_enabled": true,
2015-11-09 15:48:03 +00:00
"builds_enabled": true,
2012-08-31 07:25:36 +00:00
"wiki_enabled": true,
2013-10-01 21:13:09 +00:00
"snippets_enabled": false,
"created_at": "2013-09-30T13: 46: 02Z",
"last_activity_at": "2013-09-30T13: 46: 02Z",
2015-04-10 18:05:01 +00:00
"creator_id": 3,
2013-10-01 21:13:09 +00:00
"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"
2014-04-05 06:36:47 +00:00
},
2014-03-17 13:22:39 +00:00
"permissions": {
"project_access": {
"access_level": 10,
"notification_level": 3
},
"group_access": {
"access_level": 50,
"notification_level": 3
}
2014-04-20 10:01:55 +00:00
},
2015-02-28 17:07:53 +00:00
"archived": false,
2016-01-07 09:39:02 +00:00
"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"
2012-08-31 07:25:36 +00:00
}
```
2013-06-06 16:19:17 +00:00
### Get project events
2014-07-31 16:39:04 +00:00
Get the events for the specified project.
2013-06-06 16:19:17 +00:00
Sorted from newest to latest
```
GET /projects/:id/events
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
2013-06-06 16:19:17 +00:00
```json
2014-04-05 06:36:47 +00:00
[
{
"title": null,
"project_id": 15,
"action_name": "closed",
"target_id": 830,
"target_type": "Issue",
"author_id": 1,
"data": null,
2015-12-04 11:21:06 +00:00
"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/u/root"
},
"author_username": "root"
2014-04-05 06:36:47 +00:00
},
{
"title": null,
"project_id": 15,
"action_name": "opened",
"target_id": null,
"target_type": null,
"author_id": 1,
2015-12-04 11:21:06 +00:00
"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/u/root"
},
2014-10-31 10:08:45 +00:00
"author_username": "john",
2014-04-05 06:36:47 +00:00
"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
2013-06-06 16:19:17 +00:00
},
2014-04-05 06:36:47 +00:00
"target_title": null
2013-06-06 16:19:17 +00:00
},
2014-04-05 06:36:47 +00:00
{
"title": null,
"project_id": 15,
"action_name": "closed",
"target_id": 840,
"target_type": "Issue",
"author_id": 1,
"data": null,
2015-12-04 11:21:06 +00:00
"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/u/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/u/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/u/root"
},
"author_username": "root"
2014-04-05 06:36:47 +00:00
}
]
2013-06-06 16:19:17 +00:00
```
2013-02-14 19:43:48 +00:00
### Create project
2012-08-31 07:25:36 +00:00
2014-07-31 16:39:04 +00:00
Creates a new project owned by the authenticated user.
2012-08-31 07:25:36 +00:00
```
POST /projects
```
Parameters:
2014-08-15 06:54:50 +00:00
- `name` (required) - new project name
2014-09-09 07:52:30 +00:00
- `path` (optional) - custom repository name for new project. By default generated based on name
2014-08-15 06:54:50 +00:00
- `namespace_id` (optional) - namespace for the new project (defaults to user)
- `description` (optional) - short project description
- `issues_enabled` (optional)
- `merge_requests_enabled` (optional)
2015-11-09 15:48:03 +00:00
- `builds_enabled` (optional)
2014-08-15 06:54:50 +00:00
- `wiki_enabled` (optional)
- `snippets_enabled` (optional)
- `public` (optional) - if `true` same as setting visibility_level = 20
- `visibility_level` (optional)
- `import_url` (optional)
2013-02-27 15:49:45 +00:00
2013-03-07 13:51:56 +00:00
### Create project for user
2014-07-31 16:39:04 +00:00
Creates a new project owned by the specified user. Available only for admins.
2013-03-06 04:48:40 +00:00
```
POST /projects/user/:user_id
```
Parameters:
2014-08-15 06:54:50 +00:00
- `user_id` (required) - user_id of owner
- `name` (required) - new project name
- `description` (optional) - short project description
- `issues_enabled` (optional)
- `merge_requests_enabled` (optional)
2015-11-09 15:48:03 +00:00
- `builds_enabled` (optional)
2014-08-15 06:54:50 +00:00
- `wiki_enabled` (optional)
- `snippets_enabled` (optional)
- `public` (optional) - if `true` same as setting visibility_level = 20
- `visibility_level` (optional)
- `import_url` (optional)
2012-08-31 07:25:36 +00:00
2014-10-15 06:57:35 +00:00
### Edit project
Updates an existing project
```
PUT /projects/:id
```
Parameters:
- `id` (required) - The ID of a project
- `name` (optional) - project name
- `path` (optional) - repository name for project
- `description` (optional) - short project description
- `default_branch` (optional)
- `issues_enabled` (optional)
- `merge_requests_enabled` (optional)
2015-11-09 15:48:03 +00:00
- `builds_enabled` (optional)
2014-10-15 06:57:35 +00:00
- `wiki_enabled` (optional)
- `snippets_enabled` (optional)
- `public` (optional) - if `true` same as setting visibility_level = 20
- `visibility_level` (optional)
2015-07-08 20:27:36 +00:00
On success, method returns 200 with the updated project. If parameters are
2014-10-15 06:57:35 +00:00
invalid, 400 is returned.
2014-10-01 08:20:40 +00:00
### Fork project
Forks a project into the user namespace of the authenticated user.
```
POST /projects/fork/:id
```
Parameters:
- `id` (required) - The ID of the project to be forked
2014-08-15 06:54:50 +00:00
### Remove project
2013-10-09 11:43:18 +00:00
2014-07-31 16:39:04 +00:00
Removes a project including all associated resources (issues, merge requests etc.)
2013-10-09 11:43:18 +00:00
```
DELETE /projects/:id
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID of a project
2013-03-07 13:51:56 +00:00
2016-01-07 12:37:14 +00:00
## 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:
- `id` (required) - The ID of the project
- `file` (required) - The file to be uploaded
```json
{
"alt": "dk",
"url": "/uploads/66dbcd21ec5d24ed6ea225176098d52b/dk.png",
"is_image": true,
"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.
2013-03-07 13:51:56 +00:00
## Team members
### List project team members
2012-09-06 20:49:29 +00:00
2014-07-31 16:39:04 +00:00
Get a list of a project's team members.
2012-09-06 20:49:29 +00:00
```
2012-09-21 10:23:17 +00:00
GET /projects/:id/members
2012-09-06 20:49:29 +00:00
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `query` (optional) - Query string to search for members
2013-02-14 19:43:48 +00:00
### Get project team member
2012-09-06 20:49:29 +00:00
2013-03-07 13:51:56 +00:00
Gets a project team member.
2012-09-05 20:01:03 +00:00
2012-09-21 10:23:17 +00:00
```
GET /projects/:id/members/:user_id
```
Parameters:
2012-09-05 20:01:03 +00:00
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `user_id` (required) - The ID of a user
2012-09-21 10:23:17 +00:00
```json
{
"id": 1,
2012-12-10 22:46:31 +00:00
"username": "john_smith",
2012-09-21 10:23:17 +00:00
"email": "john@example.com",
"name": "John Smith",
2013-10-01 21:13:09 +00:00
"state": "active",
2012-09-21 10:23:17 +00:00
"created_at": "2012-05-23T08:00:58Z",
"access_level": 40
}
2012-09-05 20:01:03 +00:00
```
2012-09-21 10:23:17 +00:00
2013-02-14 19:43:48 +00:00
### Add project team member
2012-09-21 10:23:17 +00:00
2013-02-14 19:43:48 +00:00
Adds a user to a project team. This is an idempotent method and can be called multiple times
with the same parameters. Adding team membership to a user that is already a member does not
2013-03-07 13:51:56 +00:00
affect the existing membership.
2012-09-21 10:23:17 +00:00
```
POST /projects/:id/members
2012-09-05 20:01:03 +00:00
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `user_id` (required) - The ID of a user to add
- `access_level` (required) - Project access level
2013-02-14 19:43:48 +00:00
### Edit project team member
2012-09-06 20:49:29 +00:00
2014-07-31 16:39:04 +00:00
Updates a project team member to a specified access level.
2012-09-06 20:49:29 +00:00
```
2012-09-21 10:23:17 +00:00
PUT /projects/:id/members/:user_id
2012-09-06 20:49:29 +00:00
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `user_id` (required) - The ID of a team member
- `access_level` (required) - Project access level
2013-02-14 19:43:48 +00:00
### Remove project team member
2012-09-06 20:49:29 +00:00
2014-07-31 16:39:04 +00:00
Removes a user from a project team.
2012-09-06 20:49:29 +00:00
```
2012-09-21 10:23:17 +00:00
DELETE /projects/:id/members/:user_id
2012-09-06 20:49:29 +00:00
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `user_id` (required) - The ID of a team member
2012-09-06 20:49:29 +00:00
2013-02-14 19:43:48 +00:00
This method is idempotent and can be called multiple times with the same parameters.
Revoking team membership for a user who is not currently a team member is considered success.
Please note that the returned JSON currently differs slightly. Thus you should not
2013-02-01 14:20:51 +00:00
rely on the returned JSON structure.
2012-07-05 13:57:45 +00:00
2013-02-14 19:43:48 +00:00
## Hooks
2015-07-08 20:27:36 +00:00
Also called Project Hooks and Webhooks.
These are different for [System Hooks ](system_hooks.md ) that are system wide.
2013-02-14 19:43:48 +00:00
### List project hooks
2014-07-31 16:39:04 +00:00
Get a list of project hooks.
2012-09-08 17:51:12 +00:00
```
GET /projects/:id/hooks
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
2012-09-08 17:51:12 +00:00
2013-02-14 19:43:48 +00:00
### Get project hook
2012-10-12 07:38:15 +00:00
2014-07-31 16:39:04 +00:00
Get a specific hook for a project.
2012-10-12 07:38:15 +00:00
```
GET /projects/:id/hooks/:hook_id
```
2013-02-14 19:43:48 +00:00
Parameters:
2012-10-12 07:38:15 +00:00
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `hook_id` (required) - The ID of a project hook
2012-10-12 07:38:15 +00:00
2013-02-14 19:43:48 +00:00
```json
{
"id": 1,
"url": "http://example.com/hook",
2013-12-04 11:35:38 +00:00
"project_id": 3,
"push_events": "true",
"issues_events": "true",
"merge_requests_events": "true",
2015-09-24 16:33:11 +00:00
"note_events": "true",
"enable_ssl_verification": "true",
2013-02-14 19:43:48 +00:00
"created_at": "2012-10-12T17:04:47Z"
}
```
### Add project hook
2014-07-31 16:39:04 +00:00
Adds a hook to a specified project.
2012-09-08 17:51:12 +00:00
```
POST /projects/:id/hooks
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `url` (required) - The hook URL
- `push_events` - Trigger hook on push events
- `issues_events` - Trigger hook on issues events
- `merge_requests_events` - Trigger hook on merge_requests events
2014-09-19 08:23:18 +00:00
- `tag_push_events` - Trigger hook on push_tag events
2015-09-24 16:33:58 +00:00
- `note_events` - Trigger hook on note events
2015-09-24 16:34:16 +00:00
- `enable_ssl_verification` - Do SSL verification when triggering the hook
2012-10-12 07:38:15 +00:00
2013-02-14 19:43:48 +00:00
### Edit project hook
2014-07-31 16:39:04 +00:00
Edits a hook for a specified project.
2012-10-12 07:38:15 +00:00
```
PUT /projects/:id/hooks/:hook_id
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `hook_id` (required) - The ID of a project hook
- `url` (required) - The hook URL
- `push_events` - Trigger hook on push events
- `issues_events` - Trigger hook on issues events
- `merge_requests_events` - Trigger hook on merge_requests events
2014-09-19 08:23:18 +00:00
- `tag_push_events` - Trigger hook on push_tag events
2015-09-24 16:33:58 +00:00
- `note_events` - Trigger hook on note events
2015-09-24 16:34:16 +00:00
- `enable_ssl_verification` - Do SSL verification when triggering the hook
2012-10-12 07:38:15 +00:00
2013-02-14 19:43:48 +00:00
### Delete project hook
2012-09-08 17:51:12 +00:00
2014-07-31 16:39:04 +00:00
Removes a hook from a project. This is an idempotent method and can be called multiple times.
2013-02-14 19:43:48 +00:00
Either the hook is available or not.
2012-09-08 17:51:12 +00:00
```
2013-04-25 12:47:04 +00:00
DELETE /projects/:id/hooks/:hook_id
2012-09-08 17:51:12 +00:00
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `hook_id` (required) - The ID of hook to delete
2012-09-08 17:51:12 +00:00
2013-02-14 19:43:48 +00:00
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.
2013-02-15 12:54:26 +00:00
## Branches
### List branches
Lists all branches of a project.
```
GET /projects/:id/repository/branches
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
2013-02-15 12:54:26 +00:00
2013-10-01 21:13:09 +00:00
```json
[
{
2014-04-05 06:36:47 +00:00
"name": "async",
2013-10-01 21:13:09 +00:00
"commit": {
2014-04-05 06:36:47 +00:00
"id": "a2b702edecdf41f07b42653eb1abe30ce98b9fca",
"parents": [
{
"id": "3f94fc7c85061973edc9906ae170cc269b07ca55"
}
],
2013-10-01 21:13:09 +00:00
"tree": "c68537c6534a02cc2b176ca1549f4ffa190b58ee",
2015-02-03 23:18:40 +00:00
"message": "give Caolan credit where it's due (up top)",
2013-10-01 21:13:09 +00:00
"author": {
2014-04-05 06:36:47 +00:00
"name": "Jeremy Ashkenas",
"email": "jashkenas@example.com"
2013-10-01 21:13:09 +00:00
},
"committer": {
2014-04-05 06:36:47 +00:00
"name": "Jeremy Ashkenas",
"email": "jashkenas@example.com"
2013-10-01 21:13:09 +00:00
},
2014-04-05 06:36:47 +00:00
"authored_date": "2010-12-08T21:28:50+00:00",
"committed_date": "2010-12-08T21:28:50+00:00"
2013-10-01 21:13:09 +00:00
},
2014-04-05 06:36:47 +00:00
"protected": false
2013-10-01 21:13:09 +00:00
},
{
"name": "gh-pages",
"commit": {
"id": "101c10a60019fe870d21868835f65c25d64968fc",
2014-04-05 06:36:47 +00:00
"parents": [
{
"id": "9c15d2e26945a665131af5d7b6d30a06ba338aaa"
}
],
2013-10-01 21:13:09 +00:00
"tree": "fb5cc9d45da3014b17a876ad539976a0fb9b352a",
"message": "Underscore.js 1.5.2",
"author": {
"name": "Jeremy Ashkenas",
"email": "jashkenas@example.com"
},
"committer": {
"name": "Jeremy Ashkenas",
"email": "jashkenas@example.com"
},
"authored_date": "2013-09-07T12: 58: 21+00: 00",
"committed_date": "2013-09-07T12: 58: 21+00: 00"
},
"protected": false
}
]
```
2013-02-15 12:54:26 +00:00
### List single branch
Lists a specific branch of a project.
```
GET /projects/:id/repository/branches/:branch
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `branch` (required) - The name of the branch.
2013-02-15 12:54:26 +00:00
### Protect single branch
Protects a single branch of a project.
```
PUT /projects/:id/repository/branches/:branch/protect
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `branch` (required) - The name of the branch.
2013-02-15 12:54:26 +00:00
### Unprotect single branch
Unprotects a single branch of a project.
```
PUT /projects/:id/repository/branches/:branch/unprotect
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
- `branch` (required) - The name of the branch.
2013-06-27 21:49:26 +00:00
## Admin fork relation
2014-07-31 16:39:04 +00:00
Allows modification of the forked relationship between existing projects. Available only for admins.
2013-06-27 21:49:26 +00:00
### Create a forked from/to relation between existing projects.
```
POST /projects/:id/fork/:forked_from_id
```
Parameters:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID of the project
- `forked_from_id:` (required) - The ID of the project that was forked from
2013-06-27 21:49:26 +00:00
### Delete an existing forked from relationship
```
DELETE /projects/:id/fork
```
Parameter:
2014-08-15 06:54:50 +00:00
- `id` (required) - The ID of the project
2013-09-23 23:18:29 +00:00
## Search for projects by name
2014-07-31 16:39:04 +00:00
Search for projects by name which are accessible to the authenticated user.
2013-09-23 23:18:29 +00:00
```
GET /projects/search/:query
```
Parameters:
2014-12-19 12:27:27 +00:00
- `query` (required) - A string contained in the project name
- `per_page` (optional) - number of projects to return per page
- `page` (optional) - the page to retrieve
- `order_by` (optional) - Return requests ordered by `id` , `name` , `created_at` or `last_activity_at` fields
- `sort` (optional) - Return requests sorted in `asc` or `desc` order