Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.
All products
REST API

This version of GitHub Enterprise was discontinued on 2023-03-15. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

After a site administrator upgrades your Enterprise Server instance to Enterprise Server 3.9 or later, the REST API will be versioned. To learn how to find your instance's version, see "About versions of GitHub Docs". For more information, see "About API versioning."

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.

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
accept string

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

Path parameters
owner string Required

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

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

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

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 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>" \ http(s)://HOSTNAME/api/v3/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
accept string

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

Path parameters
owner string Required

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

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

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

Status codeDescription
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>" \ http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/lfs

Response

Status: 204