Get repository license agreement¶

GET /api/v5/repos/{owner}/{repo}/license

This endpoint returns the license agreement of the specified repository, including the agreement file's name, path, size, access URL, file content, and encoding, together with the SPDX identifier of the license agreement, so that users can review the repository's open source licensing information.

Access token support¶

• AtomGit user access tokens

Anonymous access¶

This endpoint allows anonymous access.

Request parameters¶

Response parameters¶

license object

Error response¶

This endpoint has no business-level error response.

HTTP response status codes¶

Request example¶

Parameter notes¶

Replace <owner> with the address of the namespace that owns the repository (the address path of the enterprise, organization, or personal namespace); replace <repo> with the repository path (path). This endpoint allows anonymous access, so the request examples do not carry an access token; if needed, you can also pass <token> (an AtomGit user access token) in the query parameters.

cURL¶

curl -X GET 'https://api.atomgit.com/api/v5/repos/{owner}/{repo}/license' \
  -H 'Accept: application/json'

JavaScript¶

// Native fetch (Node.js 18+ / browser)
const response = await fetch("https://api.atomgit.com/api/v5/repos/{owner}/{repo}/license", {
  headers: {
    "Accept": "application/json",
  },
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v5/repos/{owner}/{repo}/license",
    headers={
        "Accept": "application/json",
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

Response example¶

Status code: 200

{
  "name": "LICENSE",
  "path": "LICENSE",
  "size": 1073,
  "url": "https://api.atomgit.com/api/v5/repos/{owner}/{repo}/license",
  "html_url": "https://api.atomgit.com/{owner}/{repo}/blob/main/LICENSE",
  "content": "<file content encoded in base64>",
  "encoding": "base64",
  "license": {
    "spdx_id": "MIT"
  }
}

Error codes¶