2014-05-27 12:12:15 +00:00
# Milestones
2012-08-29 12:31:00 +00:00
## List project milestones
2013-02-20 21:51:59 +00:00
Returns a list of project milestones.
2012-08-29 12:31:00 +00:00
```
GET /projects/:id/milestones
2017-02-09 14:28:19 +00:00
GET /projects/:id/milestones?iids=42
GET /projects/:id/milestones?iids[]=42& iids[]=43
2016-04-06 11:03:07 +00:00
GET /projects/:id/milestones?state=active
GET /projects/:id/milestones?state=closed
2017-02-28 12:23:40 +00:00
GET /projects/:id/milestones?search=version
2012-08-29 12:31:00 +00:00
```
2016-04-06 18:53:17 +00:00
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2016-12-25 13:42:41 +00:00
| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user |
2017-02-09 14:28:19 +00:00
| `iids` | Array[integer] | optional | Return only the milestones having the given `iids` |
2017-02-28 12:23:40 +00:00
| `state` | string | optional | Return only `active` or `closed` milestones` |
| `search` | string | optional | Return only milestones with a title or description matching the provided string |
2016-04-06 18:53:17 +00:00
```bash
2017-03-01 17:39:40 +00:00
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/milestones
2016-04-06 18:53:17 +00:00
```
Example Response:
2013-10-02 10:08:07 +00:00
```json
[
{
2014-04-05 06:36:47 +00:00
"id": 12,
"iid": 3,
"project_id": 16,
"title": "10.0",
"description": "Version",
"due_date": "2013-11-29",
2016-11-15 17:48:30 +00:00
"start_date": "2013-11-10",
2014-04-05 06:36:47 +00:00
"state": "active",
"updated_at": "2013-10-02T09:24:18Z",
"created_at": "2013-10-02T09:24:18Z"
2013-10-02 10:08:07 +00:00
}
]
```
2013-02-20 21:51:59 +00:00
## Get single milestone
Gets a single project milestone.
2012-08-29 12:31:00 +00:00
```
GET /projects/:id/milestones/:milestone_id
```
Parameters:
2016-12-25 13:42:41 +00:00
- `id` (required) - The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user
- `milestone_id` (required) - The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user milestone
2013-02-20 21:51:59 +00:00
## Create new milestone
2012-08-29 12:31:00 +00:00
2013-02-20 21:51:59 +00:00
Creates a new project milestone.
2012-08-29 12:31:00 +00:00
```
POST /projects/:id/milestones
```
Parameters:
2016-12-25 13:42:41 +00:00
- `id` (required) - The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user
2014-04-24 22:48:22 +00:00
- `title` (required) - The title of an milestone
- `description` (optional) - The description of the milestone
- `due_date` (optional) - The due date of the milestone
2016-11-15 17:48:30 +00:00
- `start_date` (optional) - The start date of the milestone
2013-02-20 21:51:59 +00:00
2012-08-29 12:31:00 +00:00
## Edit milestone
2013-02-20 21:51:59 +00:00
Updates an existing project milestone.
2012-08-29 12:31:00 +00:00
```
PUT /projects/:id/milestones/:milestone_id
```
Parameters:
2016-12-25 13:42:41 +00:00
- `id` (required) - The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user
2014-04-24 22:48:22 +00:00
- `milestone_id` (required) - The ID of a project milestone
- `title` (optional) - The title of a milestone
- `description` (optional) - The description of a milestone
- `due_date` (optional) - The due date of the milestone
2016-11-15 17:48:30 +00:00
- `start_date` (optional) - The start date of the milestone
2014-04-24 22:48:22 +00:00
- `state_event` (optional) - The state event of the milestone (close|activate)
2015-01-21 22:59:30 +00:00
## Get all issues assigned to a single milestone
Gets all issues assigned to a single project milestone.
```
GET /projects/:id/milestones/:milestone_id/issues
```
Parameters:
2016-12-25 13:42:41 +00:00
- `id` (required) - The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user
2015-01-21 22:59:30 +00:00
- `milestone_id` (required) - The ID of a project milestone
2017-02-16 09:08:18 +00:00
## Get all merge requests assigned to a single milestone
Gets all merge requests assigned to a single project milestone.
```
GET /projects/:id/milestones/:milestone_id/merge_requests
```
Parameters:
2016-12-25 13:42:41 +00:00
- `id` (required) - The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project ](README.md#namespaced-path-encoding ) owned by the authenticated user
2017-02-28 12:23:40 +00:00
- `milestone_id` (required) - The ID of a project milestone