REST API endpoints for 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, you must have admin access to the repository (which can be inherited as an organization owner), and your role must also provide you with access to the organization's billing.
- If repository is owned by an organization on GitHub Team, you must be an organization owner or billing manager. For more information, see Roles in an organization.
- If repository is owned by an organization that is on GitHub Enterprise Cloud and is not owned by an enterprise account, you must be an organization owner or billing manager. For more information, see Roles in an organization.
- If repository is owned by an organization that is owned by an enterprise account, you must be an enterprise owner or billing manager. For more information, see Roles in an enterprise.
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.
Fine-grained access tokens for "Enable Git LFS for a repository"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
Parameters for "Enable Git LFS for a repository"
| Name, Type, Description |
|---|
accept string Setting to |
| Name, Type, Description |
|---|
owner string RequiredThe account owner of the repository. The name is not case sensitive. |
repo string RequiredThe name of the repository without the |
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:
|
Code samples 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.
Request example
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/lfsAccepted
Status: 202Disable 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.
Fine-grained access tokens for "Disable Git LFS for a repository"
This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.
Parameters for "Disable Git LFS for a repository"
| Name, Type, Description |
|---|
accept string Setting to |
| Name, Type, Description |
|---|
owner string RequiredThe account owner of the repository. The name is not case sensitive. |
repo string RequiredThe name of the repository without the |
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"
If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.
Request example
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/lfsResponse
Status: 204