Pontos de extremidade de API REST para LFS do Git
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".
Para usar esses pontos de extremidade para um repositório que pertence a uma organização, é necessário ter acesso de administrador a ele (que pode ser herdado como proprietário da organização) e sua função também deve fornecer acesso à cobrança da organização.
- Se o repositório pertencer a uma organização no GitHub Team, será necessário ser proprietário ou gerente de cobrança de uma organização. Para obter mais informações, confira "Funções em uma organização".
- Se o repositório pertencer a uma organização no GitHub Enterprise Cloud e não pertencer a uma conta corporativa, será necessário ser proprietário ou gerente de cobrança de uma organização. Para obter mais informações, confira "Funções em uma organização".
- Se o repositório pertencer a uma organização pertencente a uma conta corporativa, será necessário ser um proprietário ou gerente de cobrança de empresa. Para obter mais informações, confira "Funções em uma empresa".
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.
Tokens de acesso refinados para "Enable Git LFS for a repository"
Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.
Parâmetros para "Enable Git LFS for a repository"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository without the |
Códigos de status de resposta HTTP para "Enable Git LFS for a repository"
Código de status | Descrição |
---|---|
202 | Accepted |
403 | We will return a 403 with one of the following messages:
|
Exemplos de código para "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
.
Exemplo de solicitação
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
Status: 202
Disable 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.
Tokens de acesso refinados para "Disable Git LFS for a repository"
Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.
Parâmetros para "Disable Git LFS for a repository"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository without the |
Códigos de status de resposta HTTP para "Disable Git LFS for a repository"
Código de status | Descrição |
---|---|
204 | No Content |
Exemplos de código para "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
.
Exemplo de solicitação
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