Skip to main content
L’API REST est maintenant versionnée. Pour plus d’informations, consultez « À propos des versions de l’API ».

Points de terminaison d’API REST pour les LFS Git

Utilisez l’API REST pour activer ou désactiver la fonctionnalité Stockage Fichiers volumineux Git (LFS) pour un référentiel.

À propos de Git LFS

Vous pouvez utiliser Git LFS pour stocker des fichiers volumineux dans un dépôt Git. L’API REST vous permet d’activer ou de désactiver la fonctionnalité pour un dépôt individuel. Pour plus d’informations sur Git LFS, consultez « À propos du stockage de fichiers Git volumineux ».

Les personnes ayant un accès administrateur à un référentiel peuvent utiliser ces points de terminaison.

L’utilisation de Git LFS est soumise à facturation. Pour plus d’informations, consultez « À propos de la facturation pour Git Large File Storage ».

Si vous souhaitez utiliser ces points de terminaison pour un dépôt qui appartient à une organisation, vous devez disposer d’un accès administrateur au dépôt (dont vous pouvez hériter si vous êtes propriétaire d’organisation), et votre rôle doit également vous fournir l’accès à la facturation de l’organisation.

  • Si le dépôt appartient à une organisation sur GitHub Team, vous devez être propriétaire de l’organisation ou gestionnaire de facturation. Pour plus d’informations, consultez « Rôles dans une organisation ».
  • Si le dépôt appartient à une organisation qui est sur GitHub Enterprise Cloud et qui n’appartient pas à un compte d’entreprise, vous devez être propriétaire de l’organisation ou gestionnaire de facturation. Pour plus d’informations, consultez « Rôles dans une organisation ».
  • Si le dépôt appartient à une organisation appartenant à un compte d’entreprise, vous devez être propriétaire d’entreprise ou gestionnaire de facturation. Pour plus d’informations, consultez « Rôles dans une entreprise ».

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.

Jetons d’accès affinés pour « Enable Git LFS for a repository »

Ce point de terminaison ne fonctionne pas avec les jetons d’accès utilisateur d’application GitHub, les jetons d’accès d’installation d’application GitHub ou les jetons d’accès personnels affinés.

Paramètres pour « Enable Git LFS for a repository »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
owner string Obligatoire

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

repo string Obligatoire

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

Codes d’état de la réponse HTTP pour « Enable Git LFS for a repository »

Code d’étatDescription
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 .

Exemples de code pour « Enable Git LFS for a repository »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

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.

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

Jetons d’accès affinés pour « Disable Git LFS for a repository »

Ce point de terminaison ne fonctionne pas avec les jetons d’accès utilisateur d’application GitHub, les jetons d’accès d’installation d’application GitHub ou les jetons d’accès personnels affinés.

Paramètres pour « Disable Git LFS for a repository »

En-têtes
Nom, Type, Description
accept string

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

Paramètres de chemin d’accès
Nom, Type, Description
owner string Obligatoire

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

repo string Obligatoire

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

Codes d’état de la réponse HTTP pour « Disable Git LFS for a repository »

Code d’étatDescription
204

No Content

Exemples de code pour « Disable Git LFS for a repository »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

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