debian-mirror-gitlab/doc/ci/api/projects.md

149 lines
3.2 KiB
Markdown
Raw Normal View History

2015-09-25 12:07:36 +05:30
# Projects API
This API is intended to aid in the setup and configuration of
2015-11-26 14:37:03 +05:30
projects on GitLab CI.
2015-09-25 12:07:36 +05:30
__Authentication is done by GitLab user token & GitLab url__
## Projects
### List Authorized Projects
Lists all projects that the authenticated user has access to.
```
GET /ci/projects
```
Returns:
```json
[
{
"id" : 271,
"name" : "gitlabhq",
"timeout" : 1800,
"token" : "iPWx6WM4lhHNedGfBpPJNP",
"default_ref" : "master",
"gitlab_url" : "http://demo.gitlabhq.com/gitlab/gitlab-shell",
"path" : "gitlab/gitlab-shell",
"always_build" : false,
"polling_interval" : null,
"public" : false,
"ssh_url_to_repo" : "git@demo.gitlab.com:gitlab/gitlab-shell.git",
"gitlab_id" : 3
},
{
"id" : 272,
"name" : "gitlab-ci",
"timeout" : 1800,
"token" : "iPWx6WM4lhHNedGfBpPJNP",
"default_ref" : "master",
"gitlab_url" : "http://demo.gitlabhq.com/gitlab/gitlab-shell",
"path" : "gitlab/gitlab-shell",
"always_build" : false,
"polling_interval" : null,
"public" : false,
"ssh_url_to_repo" : "git@demo.gitlab.com:gitlab/gitlab-shell.git",
"gitlab_id" : 4
}
]
```
### List Owned Projects
Lists all projects that the authenticated user owns.
```
GET /ci/projects/owned
```
Returns:
```json
[
{
"id" : 272,
"name" : "gitlab-ci",
"timeout" : 1800,
"token" : "iPWx6WM4lhHNedGfBpPJNP",
"default_ref" : "master",
"gitlab_url" : "http://demo.gitlabhq.com/gitlab/gitlab-shell",
"path" : "gitlab/gitlab-shell",
"always_build" : false,
"polling_interval" : null,
"public" : false,
"ssh_url_to_repo" : "git@demo.gitlab.com:gitlab/gitlab-shell.git",
"gitlab_id" : 4
}
]
```
### Single Project
Returns information about a single project for which the user is
authorized.
GET /ci/projects/:id
Parameters:
2015-11-26 14:37:03 +05:30
* `id` (required) - The ID of the GitLab CI project
2015-09-25 12:07:36 +05:30
### Create Project
2015-11-26 14:37:03 +05:30
Creates a GitLab CI project using GitLab project details.
2015-09-25 12:07:36 +05:30
POST /ci/projects
Parameters:
* `name` (required) - The name of the project
2015-11-26 14:37:03 +05:30
* `gitlab_id` (required) - The ID of the project on the GitLab instance
2015-09-25 12:07:36 +05:30
* `default_ref` (optional) - The branch to run on (default to `master`)
### Update Project
2015-11-26 14:37:03 +05:30
Updates a GitLab CI project using GitLab project details that the
2015-09-25 12:07:36 +05:30
authenticated user has access to.
PUT /ci/projects/:id
Parameters:
* `name` - The name of the project
* `default_ref` - The branch to run on (default to `master`)
### Remove Project
2015-11-26 14:37:03 +05:30
Removes a GitLab CI project that the authenticated user has access to.
2015-09-25 12:07:36 +05:30
DELETE /ci/projects/:id
Parameters:
2015-11-26 14:37:03 +05:30
* `id` (required) - The ID of the GitLab CI project
2015-09-25 12:07:36 +05:30
### Link Project to Runner
Links a runner to a project so that it can make builds (only via
authorized user).
POST /ci/projects/:id/runners/:runner_id
Parameters:
2015-11-26 14:37:03 +05:30
* `id` (required) - The ID of the GitLab CI project
* `runner_id` (required) - The ID of the GitLab CI runner
2015-09-25 12:07:36 +05:30
### Remove Project from Runner
Removes a runner from a project so that it can not make builds (only
via authorized user).
DELETE /ci/projects/:id/runners/:runner_id
Parameters:
2015-11-26 14:37:03 +05:30
* `id` (required) - The ID of the GitLab CI project
* `runner_id` (required) - The ID of the GitLab CI runner