ownerstringrequired
repostringrequired
Create a milestone
post
http://HOSTNAME/api/v3/repos/{owner}/{repo}/milestones
Path Parameters
Body
application/json
Body
application/json
titlestringrequired
The title of the milestone.
statestring
The state of the milestone. Either open or closed.
Allowed values:openclosed
Default:open
descriptionstring
A description of the milestone.
due_onstring(date-time)
The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
application/json
Response
application/json
Response
Milestone
A collection of related issues and pull requests.
urlstring(uri)required
Example:https://api.github.com/repos/octocat/Hello-World/milestones/1
html_urlstring(uri)required
Example:https://github.com/octocat/Hello-World/milestones/v1.0
labels_urlstring(uri)required
Example:https://api.github.com/repos/octocat/Hello-World/milestones/1/labels
idintegerrequired
Example:1002604
node_idstringrequired
Example:MDk6TWlsZXN0b25lMTAwMjYwNA==
numberintegerrequired
The number of the milestone.
Example:42
statestringrequired
The state of the milestone.
Allowed values:openclosed
Default:open
Example:open
titlestringrequired
The title of the milestone.
Example:v1.0
descriptionstring | nullrequired
Example:Tracking milestone for version 1.0
creatorobject | nullrequired
Simple User
Show Child Parameters
open_issuesintegerrequired
Example:4
closed_issuesintegerrequired
Example:8
created_atstring(date-time)required
Example:2011-04-10T20:09:31Z
updated_atstring(date-time)required
Example:2014-03-03T18:58:10Z
closed_atstring | null(date-time)required
Example:2013-02-12T13:22:01Z
due_onstring | null(date-time)required
Example:2012-10-09T23:39:01Z
post/repos/{owner}/{repo}/milestones
Path Parameters
Body
{
"title": "v1.0",
"state": "open",
"description": "Tracking milestone for version 1.0",
"due_on": "2012-10-09T23:39:01Z"
}
application/json
Get a milestone
get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/milestones/{milestone_number}
Path Parameters
ownerstringrequired
repostringrequired
milestone_numberintegerrequired
milestone_number parameter
Response
application/json
Response
application/json
Response
Milestone
A collection of related issues and pull requests.
urlstring(uri)required
Example:https://api.github.com/repos/octocat/Hello-World/milestones/1
html_urlstring(uri)required
Example:https://github.com/octocat/Hello-World/milestones/v1.0
labels_urlstring(uri)required
Example:https://api.github.com/repos/octocat/Hello-World/milestones/1/labels
idintegerrequired
Example:1002604
node_idstringrequired
Example:MDk6TWlsZXN0b25lMTAwMjYwNA==
numberintegerrequired
The number of the milestone.
Example:42
statestringrequired
The state of the milestone.
Allowed values:openclosed
Default:open
Example:open
titlestringrequired
The title of the milestone.
Example:v1.0
descriptionstring | nullrequired
Example:Tracking milestone for version 1.0
creatorobject | nullrequired
Simple User
Show Child Parameters
open_issuesintegerrequired
Example:4
closed_issuesintegerrequired
Example:8
created_atstring(date-time)required
Example:2011-04-10T20:09:31Z
updated_atstring(date-time)required
Example:2014-03-03T18:58:10Z
closed_atstring | null(date-time)required
Example:2013-02-12T13:22:01Z
due_onstring | null(date-time)required
Example:2012-10-09T23:39:01Z
get/repos/{owner}/{repo}/milestones/{milestone_number}
Path Parameters
application/json
Update a milestone
patch
http://HOSTNAME/api/v3/repos/{owner}/{repo}/milestones/{milestone_number}
Path Parameters
ownerstringrequired
repostringrequired
milestone_numberintegerrequired
milestone_number parameter
Body
application/json
Body
application/json
titlestring
The title of the milestone.
statestring
The state of the milestone. Either open or closed.
Allowed values:openclosed
Default:open
descriptionstring
A description of the milestone.
due_onstring(date-time)
The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
200 application/json
Response
200 application/json
Response
Milestone
A collection of related issues and pull requests.
urlstring(uri)required
Example:https://api.github.com/repos/octocat/Hello-World/milestones/1
html_urlstring(uri)required
Example:https://github.com/octocat/Hello-World/milestones/v1.0
labels_urlstring(uri)required
Example:https://api.github.com/repos/octocat/Hello-World/milestones/1/labels
idintegerrequired
Example:1002604
node_idstringrequired
Example:MDk6TWlsZXN0b25lMTAwMjYwNA==
numberintegerrequired
The number of the milestone.
Example:42
statestringrequired
The state of the milestone.
Allowed values:openclosed
Default:open
Example:open
titlestringrequired
The title of the milestone.
Example:v1.0
descriptionstring | nullrequired
Example:Tracking milestone for version 1.0
creatorobject | nullrequired
Simple User
Show Child Parameters
open_issuesintegerrequired
Example:4
closed_issuesintegerrequired
Example:8
created_atstring(date-time)required
Example:2011-04-10T20:09:31Z
updated_atstring(date-time)required
Example:2014-03-03T18:58:10Z
closed_atstring | null(date-time)required
Example:2013-02-12T13:22:01Z
due_onstring | null(date-time)required
Example:2012-10-09T23:39:01Z
patch/repos/{owner}/{repo}/milestones/{milestone_number}
Path Parameters
Body
{
"title": "v1.0",
"state": "open",
"description": "Tracking milestone for version 1.0",
"due_on": "2012-10-09T23:39:01Z"
}
200 application/json
Delete a milestone
delete
http://HOSTNAME/api/v3/repos/{owner}/{repo}/milestones/{milestone_number}
Path Parameters
ownerstringrequired
repostringrequired
milestone_numberintegerrequired
milestone_number parameter
Response
Response
Response
delete/repos/{owner}/{repo}/milestones/{milestone_number}
Path Parameters
List labels for issues in a milestone
get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/milestones/{milestone_number}/labels
Query Parameters
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Path Parameters
ownerstringrequired
repostringrequired
milestone_numberintegerrequired
milestone_number parameter
Response
200 application/json
Response
200 application/json
Response
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
idinteger(int64)required
Example:208045946
node_idstringrequired
Example:MDU6TGFiZWwyMDgwNDU5NDY=
urlstring(uri)required
URL for the label
Example:https://api.github.com/repositories/42/labels/bug
namestringrequired
The name of the label.
Example:bug
descriptionstring | nullrequired
Example:Something isn't working
colorstringrequired
6-character hex code, without the leading #, identifying the color
Example:FFFFFF
defaultbooleanrequired
Example:true
get/repos/{owner}/{repo}/milestones/{milestone_number}/labels
Path Parameters
Query Parameters
200 application/json