Skip to main content
The REST API is now versioned. For more information, see "About API versioning".

Git LFS

Você pode habilitar ou desabilitar o Git Large File Storage (LFS) em um repositório.

Sobre a API do Git LFS

Você pode usar o Git LFS para armazenar arquivos grandes em um repositório Git. A API do Git LFS 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".

As pessoas com acesso de administrador a um repositório podem usar a API do Git LFS.

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 a API do Git LFS para um repositório que pertença a uma organização, sua função precisará dar acesso de cobrança à organização ou à empresa .

Propriedade do repositórioAcesso necessário ao repositórioFunção necessáriaMais informações
Conta pessoalAdminN/DN/D
  • Organização em GitHub Team
  • Organização em GitHub Enterprise Cloud, mas não em uma empresa
Administração, que será herdado se você for um proprietário da organizaçãoProprietário da organização ou gerente de cobrança"Funções em uma organização"
Organização em uma empresaAdministração, que poderá ser herdado se você for proprietário da organizaçãoProprietário corporativo ou gerente de cobrança"Funções em uma empresa"

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

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

put/repos/{owner}/{repo}/lfs
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

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

Status codeDescription
204

No Content

Code samples

delete/repos/{owner}/{repo}/lfs
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