Skip to main content
Manja / GitHub

Create a milestone

POST/repos/{owner}/{repo}/milestones
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
owner string
required
repo string
required
Body Params
required
application/jsonobject
description string
optional

A description of the milestone.

due_on string<date-time>
optional

The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.

state string
optional

The state of the milestone. Either `open` or `closed`.

Default: open

Allowed: "open""closed"

title string
required

The title of the milestone.

Responses

application/json Milestone object

Response

Headers
Location string

Example: https://api.github.com/repos/octocat/Hello-World/milestones/1

closed_at string<date-time>
requirednullable

Example: 2013-02-12T13:22:01Z

closed_issues integer
required

Example: 8

created_at string<date-time>
required

Example: 2011-04-10T20:09:31Z

creator Simple User object
requirednullable

Simple User

avatar_url string<uri>
required

Example: https://github.com/images/error/octocat_happy.gif

email string
optionalnullable
events_url string
required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>
required

Example: https://api.github.com/users/octocat/followers

following_url string
required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string
required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string
requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>
required

Example: https://github.com/octocat

id integer
required

Example: 1

login string
required

Example: octocat

name string
optionalnullable
node_id string
required

Example: MDQ6VXNlcjE=

organizations_url string<uri>
required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>
required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>
required

Example: https://api.github.com/users/octocat/repos

site_admin boolean
required
starred_at string
optional

Example: "2020-07-09T00:17:55Z"

starred_url string
required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>
required

Example: https://api.github.com/users/octocat/subscriptions

type string
required

Example: User

url string<uri>
required

Example: https://api.github.com/users/octocat

description string
requirednullable

Example: Tracking milestone for version 1.0

due_on string<date-time>
requirednullable

Example: 2012-10-09T23:39:01Z

html_url string<uri>
required

Example: https://github.com/octocat/Hello-World/milestones/v1.0

id integer
required

Example: 1002604

labels_url string<uri>
required

Example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels

node_id string
required

Example: MDk6TWlsZXN0b25lMTAwMjYwNA==

number integer
required

The number of the milestone.

Example: 42

open_issues integer
required

Example: 4

state string
required

The state of the milestone.

Default: open

Example: open

Allowed: "open""closed"

title string
required

The title of the milestone.

Example: v1.0

updated_at string<date-time>
required

Example: 2014-03-03T18:58:10Z

url string<uri>
required

Example: https://api.github.com/repos/octocat/Hello-World/milestones/1

application/json Basic Error object

Resource not found

documentation_url string
optional
message string
optional
status string
optional
url string
optional
application/json Validation Error object

Validation failed

documentation_url string
required
errors array[object]
optional
items object
code string
required
field string
optional
index integer
optional
message string
optional
resource string
optional
value
optional
message string
required