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.
The REST API is now versioned. 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.

Sobre o Git LFS

Você pode usar o Git LFS para armazenar arquivos grandes em um repositório Git. A API REST permite habilitar ou desabilitar o recurso em um repositório individual. Para obter mais informações sobre o Git LFS, confira "Sobre o Git LFS".

Pessoas com acesso de administrador em um repositório podem usar esses pontos de extremidade.

O uso do Git LFS está sujeito à cobrança. Para obter mais informações, confira "Sobre cobrança para Git Large File Storage".

Se você quiser usar esses pontos de extremidade para um repositório que pertença a uma organização, sua função precisará fornecer acesso à cobrança da organização. Para obter mais informações, confira "Funções de uma organização".

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
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 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>"\ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/lfs

Accepted

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
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 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>"\ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/lfs

Response

Status: 204