Get the license for a repository

GET

/repos/{owner}/{repo}/license

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///license'

Response Example

{
    "_links": {
        "git": "http://example.com",
        "html": "http://example.com",
        "self": "http://example.com"
    },
    "content": "string",
    "download_url": "http://example.com",
    "encoding": "string",
    "git_url": "http://example.com",
    "html_url": "http://example.com",
    "license": {
        "html_url": "http://example.com",
        "key": "mit",
        "name": "MIT License",
        "node_id": "MDc6TGljZW5zZW1pdA==",
        "spdx_id": "MIT",
        "url": "https://api.github.com/licenses/mit"
    },
    "name": "string",
    "path": "string",
    "sha": "string",
    "size": 0,
    "type": "string",
    "url": "http://example.com"
}

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

Responses

🟢200Response

application/json

Body

License Content

_links

object

required

git

string <uri> | null

required

html

string <uri> | null

required

self

string <uri>

required

content

string

required

download_url

string <uri> | null

required

encoding

string

required

git_url

string <uri> | null

required

html_url

string <uri> | null

required

license

object (License Simple) | null

required

License Simple

html_url

string <uri>

optional

key

string

required

Example:

mit

name

string

required

Example:

MIT License

node_id

string

required

Example:

MDc6TGljZW5zZW1pdA==

spdx_id

string | null

required

Example:

MIT

url

string <uri> | null

required

Example:

https://api.github.com/licenses/mit

name

string

required

path

string

required

sha

string

required

size

integer

required

type

string

required

url

string <uri>

required

Modified at 2023-08-15 02:59:27

Get a license

Render a Markdown document