Git LFS 的 REST API 端点

关于 Git LFS

可以使用 Git LFS 将大文件存储在 Git 存储库中。使用 REST API 可以为单个存储库启用或禁用该功能。有关 Git LFS 的详细信息，请参阅“关于 Git Large File Storage”。

对存储库具有管理员权限的人员可以使用这些终结点。

Git LFS 的使用需付费。有关详细信息，请参阅“关于 Git Large File Storage 的计费”。

如果要将这些终结点用于属于组织的存储库，则必须对存储库具有管理员访问权限（可以作为组织所有者继承），并且你的角色还必须提供对组织计费的访问权限。

如果存储库由 GitHub Team 上的组织拥有，则你必须是组织所有者或计费经理。有关详细信息，请参阅“组织中的角色”。
如果存储库由 GitHub Enterprise Cloud 上的组织拥有，并且不归企业帐户所有，则你必须是组织所有者或计费经理。有关详细信息，请参阅“组织中的角色”。
如果存储库由企业帐户拥有的组织拥有，则你必须是企业所有者或计费经理。有关详细信息，请参阅“企业中的角色”。

Enable Git LFS for a repository

Enables Git LFS for a repository.

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

“Enable Git LFS for a repository”的细粒度访问令牌

此终结点不适用于 GitHub 应用程序用户访问令牌、GitHub 应用程序安装访问令牌或细粒度个人访问令牌。

“Enable Git LFS for a repository”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`owner` string 必须 The account owner of the repository. The name is not case sensitive.
`repo` string 必须 The name of the repository without the `.git` extension. The name is not case sensitive.

“Enable Git LFS for a repository”的 HTTP 响应状态代码

状态代码	说明
`202`	Accepted
`403`	We will return a 403 with one of the following messages: Git LFS support not enabled because Git LFS is globally disabled. Git LFS support not enabled because Git LFS is disabled for the root repository in the network. Git LFS support not enabled because Git LFS is disabled for .

“Enable Git LFS for a repository”的示例代码

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

请求示例

put/repos/{owner}/{repo}/lfs

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/lfs

Accepted

Status: 202

Disable Git LFS for a repository

Disables Git LFS for a repository.

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

“Disable Git LFS for a repository”的细粒度访问令牌

此终结点不适用于 GitHub 应用程序用户访问令牌、GitHub 应用程序安装访问令牌或细粒度个人访问令牌。

“Disable Git LFS for a repository”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`owner` string 必须 The account owner of the repository. The name is not case sensitive.
`repo` string 必须 The name of the repository without the `.git` extension. The name is not case sensitive.

“Disable Git LFS for a repository”的 HTTP 响应状态代码

状态代码	说明
`204`	No Content

“Disable Git LFS for a repository”的示例代码

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

请求示例

delete/repos/{owner}/{repo}/lfs

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/lfs

Response

Status: 204