Git LFS - GitHub Docs

Git LFS

Use the REST API to enable or disable Git Large File Storage (LFS) for a repository.

About Git LFS

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

People with admin access to a repository can use these endpoints.

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

If you want to use these endpoints for a repository that belongs to an organization, your role must provide you with access to the organization's billing. For more information, see "Roles in an organization."

Enable Git LFS for a repository

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

Parameters for "Enable Git LFS for a repository"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.

HTTP response status codes for "Enable Git LFS for a repository"

Status code	Description
`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 for "Enable Git LFS for a repository"

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. Access tokens must have the admin:enterprise scope.

Parameters for "Disable Git LFS for a repository"

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.

HTTP response status codes for "Disable Git LFS for a repository"

Status code	Description
`204`	No Content

Code samples for "Disable Git LFS for a repository"

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