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

REST API を使って、リポジトリの Git Large File Storage (LFS) を有効または無効にします。

Git LFS について

Git LFS を使って、Git リポジトリに大きなファイルを格納することができます。 REST API を使うと、個々のリポジトリの機能を有効または無効にすることができます。 Git LFS について詳しくは、「Git LFS について」を参照してください。

リポジトリに対する管理者アクセス権を持つユーザーは、これらのエンドポイントを使用できます。

Git LFS の使用は課金対象です。 詳細については、「 Git Large File Storage の課金について」を参照してください。

組織に属するリポジトリにこれらのエンドポイントを使う場合は、組織またはエンタープライズの課金へのアクセス権がロールで提供されている必要があります。

リポジトリの所有権必要なリポジトリ アクセス必要なロール詳細情報
個人用アカウント[Admin]該当なし該当なし
  • GitHub Team の Organization
  • GitHub Enterprise Cloud の Organization ですが、Enterprise 内には含まれない
管理者。Organization の所有者である場合に継承されるOrganization の所有者または支払いマネージャー組織のロール
Enterprise 内の Organization管理者。Organization の所有者である場合に継承できるEnterprise の所有者または支払いマネージャー"Enterprise におけるロール"

Enable Git LFS for a repository

Enables Git LFS for a repository. Access tokens must have the admin:enterprise scope.

Parameters

Headers
名前, Type, 説明
acceptstring

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

Path parameters
名前, Type, 説明
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 code説明
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
名前, Type, 説明
acceptstring

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

Path parameters
名前, Type, 説明
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 code説明
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