ownerstringrequired
repostringrequired
Get the license for a repository
This method returns the contents of the repository’s license file, if one is detected.
Similar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
get
{protocol}://{hostname}/api/v3/repos/{owner}/{repo}/license
Path Parameters
Response
200 application/json
Response
200 application/json
Response
License Content
License Content
namestringrequired
pathstringrequired
shastringrequired
sizeintegerrequired
urlstring(uri)required
html_urlstring | null(uri)required
git_urlstring | null(uri)required
download_urlstring | null(uri)required
typestringrequired
contentstringrequired
encodingstringrequired
_linksobjectrequired
Show Child Parameters
licenseobject | nullrequired
License Simple
Show Child Parameters
get/repos/{owner}/{repo}/license
Path Parameters
200 application/json
Render a Markdown document
post
{protocol}://{hostname}/api/v3/markdown
Body
application/json
Body
application/json
textstringrequired
The Markdown text to render in HTML.
modestring
The rendering mode. Can be either markdown or gfm.
Allowed values:markdowngfm
Default:markdown
Example:markdown
contextstring
The repository context to use when creating references in gfm mode. For example, setting context to octo-org/octo-repo will change the text #42 into an HTML link to issue 42 in the octo-org/octo-repo repository.
Response
text/html
Response
text/html
Response
string
post/markdown
Body
{
"text": "text"
}
text/html
Render a Markdown document in raw mode
You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.
post
{protocol}://{hostname}/api/v3/markdown/raw
Body
Body
string
Response
text/html
Response
text/html
Response
string
post/markdown/raw
Body
{}
text/html
GitHub API Root
Get Hypermedia links to resources accessible in GitHub’s REST API
get
{protocol}://{hostname}/api/v3/
Response
200 application/json
Response
200 application/json
Response
current_user_urlstring(uri-template)required
current_user_authorizations_html_urlstring(uri-template)required
authorizations_urlstring(uri-template)required
code_search_urlstring(uri-template)required
commit_search_urlstring(uri-template)required
emails_urlstring(uri-template)required
emojis_urlstring(uri-template)required
events_urlstring(uri-template)required
feeds_urlstring(uri-template)required
followers_urlstring(uri-template)required
following_urlstring(uri-template)required
gists_urlstring(uri-template)required
hub_urlstring(uri-template)required
issue_search_urlstring(uri-template)required
issues_urlstring(uri-template)required
keys_urlstring(uri-template)required
label_search_urlstring(uri-template)required
notifications_urlstring(uri-template)required
organization_urlstring(uri-template)required
organization_repositories_urlstring(uri-template)required
organization_teams_urlstring(uri-template)required
public_gists_urlstring(uri-template)required
rate_limit_urlstring(uri-template)required
repository_urlstring(uri-template)required
repository_search_urlstring(uri-template)required
current_user_repositories_urlstring(uri-template)required
starred_urlstring(uri-template)required
starred_gists_urlstring(uri-template)required
topic_search_urlstring(uri-template)
user_urlstring(uri-template)required
user_organizations_urlstring(uri-template)required
user_repositories_urlstring(uri-template)required
user_search_urlstring(uri-template)required
get/
200 application/json
Get GitHub Enterprise Server meta information
get
{protocol}://{hostname}/api/v3/meta
Response
application/json
Response
application/json
Response
Api Overview
Api Overview
verifiable_password_authenticationbooleanrequired
Example:true
packagesarray[string]
Example:["13.65.0.0/16","157.55.204.33/32","2a01:111:f403:f90c::/62"]
dependabotarray[string]
Example:["192.168.7.15/32","192.168.7.16/32"]
installed_versionstring
Example:3.0.0
get/meta
application/json