Skip to main content

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the new Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks REST API pages.

Git LFS

You can enable or disable Git Large File Storage (LFS) for a repository.

About the Git LFS API

You can use Git LFS to store large files in a Git repository. The Git LFS API allows you to enable or disable the feature for an individual repository. For more information about Git LFS, see "About Git LFS."

People with admin access to a repository can use the Git LFS API.

Usage of Git LFS is subject to billing. For more information, see "About billing for Git Large File Storage."

If you want to use the Git LFS API for a repository that belongs to an organization, your role must provide you with access to the organization's or enterprise's billing.

Repository ownershipRequired repository accessRequired roleMore information
Personal accountAdminN/AN/A
  • Organization on GitHub Team
  • Organization on GitHub Enterprise Cloud, but not in an enterprise
Admin, which is inherited if you are an organization ownerOrganization owner or billing manager"Roles in an organization"
Organization in an enterpriseAdmin, which can be inherited if you are an organization ownerEnterprise owner or billing manager"Roles in an enterprise"

Enable Git LFS for a repository

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

Status: 202

Disable Git LFS for a repository

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