Skip to main content
The REST API is now versioned. For more information, see "About API versioning".

Git LFS

可以为存储库启用或禁用 Git Large File Storage (LFS)。

关于 Git LFS API

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

对存储库具有管理员访问权限的人可以使用 Git LFS API。

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

如果想要将 Git LFS API 用于属于组织的存储库,则你的角色必须提供对组织或企业计费的访问权限。

存储库所有权所需的存储库访问权限所需角色详细信息
个人帐户管理员空值空值
  • GitHub Team 上的组织
  • GitHub Enterprise Cloud 上的组织,但不在企业中
管理员,如果你是组织所有者,则会继承组织所有者或计费管理员组织中的角色
企业中的组织管理员,如果你是组织所有者,则可以继承企业所有者或计费管理员企业中的角色

Enable Git LFS for a repository

Enables Git LFS for a repository. Access tokens must have the admin:enterprise scope.

Parameters

Headers
Name, Type, Description
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
Name, Type, Description
ownerstringRequired

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

repostringRequired

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

HTTP response status codes

Status codeDescription
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 .

Code samples

put/repos/{owner}/{repo}/lfs
curl \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://api.github.com/repos/OWNER/REPO/lfs

Accepted

Disable Git LFS for a repository

Disables Git LFS for a repository. Access tokens must have the admin:enterprise scope.

Parameters

Headers
Name, Type, Description
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
Name, Type, Description
ownerstringRequired

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

repostringRequired

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

HTTP response status codes

Status codeDescription
204

No Content

Code samples

delete/repos/{owner}/{repo}/lfs
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ https://api.github.com/repos/OWNER/REPO/lfs

Response

Status: 204