Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais atualizadas, acesse a documentação em inglês.
O controle de versão da API REST já foi feito. Para obter mais informações, confira "Sobre o controle de versão da API".

Git LFS

Use a API REST para habilitar ou desabilitar o Git Large File Storage (LFS) em um repositório.

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 saber mais sobre o Git LFS, confira "Sobre armazenamento de arquivo grande do Git".

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 a cobrança do 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 ou da 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.

Parâmetros para "Enable Git LFS for a repository"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
owner string Obrigatório

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

repo string Obrigatório

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

Códigos de status de resposta HTTP para "Enable Git LFS for a repository"

Código de statusDescrição
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 .

Exemplos de código para "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.

Parâmetros para "Disable Git LFS for a repository"

Cabeçalhos
Nome, Tipo, Descrição
accept string

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

Parâmetros de caminho
Nome, Tipo, Descrição
owner string Obrigatório

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

repo string Obrigatório

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

Códigos de status de resposta HTTP para "Disable Git LFS for a repository"

Código de statusDescrição
204

No Content

Exemplos de código para "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