Search
K
GitHub v3 REST API

License Content

object

License Content

namestringrequired
pathstringrequired
shastringrequired
sizeintegerrequired
urlstring(uri)required
html_urlstring(uri)required
git_urlstring(uri)required
download_urlstring(uri)required
typestringrequired
contentstringrequired
encodingstringrequired
_linksobjectrequired
Show Child Parameters
licenseobjectrequired

License Simple

Show Child Parameters
Example

Milestone

object

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

descriptionstringrequired

Example:Tracking milestone for version 1.0

creatorobjectrequired

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(date-time)required

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

due_onstring(date-time)required

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

Example

Pages Source Hash

object
branchstringrequired
pathstringrequired
Example

Pages Https Certificate

object
statestringrequired

Allowed values:newauthorization_createdauthorization_pendingauthorizedauthorization_revokedissueduploadedapprovederroredbad_authzdestroy_pendingdns_changed

Example:approved

descriptionstringrequired

Example:Certificate is approved

domainsarray[string]required

Array of the domain set and its alternate name (if it is configured)

Example:example.com, www.example.com

expires_atstring(date)
Example

GitHub Pages

object

The configuration for GitHub Pages for a repository.

urlstring(uri)required

The API address for accessing this Page resource.

Example:https://api.github.com/repos/github/hello-world/pages

statusstringrequired

The status of the most recent build of the Page.

Allowed values:builtbuildingerrored

Example:built

cnamestringrequired

The Pages site’s custom domain

Example:example.com

protected_domain_statestring

The state if the domain is verified

Allowed values:pendingverifiedunverified

Example:pending

pending_domain_unverified_atstring(date-time)

The timestamp when a pending domain becomes unverified.

custom_404booleanrequired

Whether the Page has a custom 404 page.

Default:false

html_urlstring(uri)

The web address the Page can be accessed from.

Example:https://example.com

sourceobject
Show Child Parameters
publicbooleanrequired

Whether the GitHub Pages site is publicly visible. If set to true, the site is accessible to anyone on the internet. If set to false, the site will only be accessible to users who have at least read access to the repository that published the site.

Example:true

https_certificateobject
Show Child Parameters
https_enforcedboolean

Whether https is enabled on the domain

Example:true

Example