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 LFS."
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 or enterprise's billing.
Repository ownership | Required repository access | Required role | More information |
---|---|---|---|
Personal account | Admin | N/A | N/A |
| Admin, which is inherited if you are an organization owner | Organization owner or billing manager | "Roles in an organization" |
Organization in an enterprise | Admin, which can be inherited if you are an organization owner | Enterprise owner or billing manager | "Roles in an enterprise" |
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 |
accept stringSetting to |
Path parameters |
Name, Type, Description |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
HTTP response status codes
Status code | Description |
---|---|
202 | Accepted |
403 | We will return a 403 with one of the following messages:
|
Code samples
curl \
-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
Headers |
---|
Name, Type, Description |
accept stringSetting to |
Path parameters |
Name, Type, Description |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
HTTP response status codes
Status code | Description |
---|---|
204 | No Content |
Code samples
curl \
-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