Git LFS

Use the REST API to enable or disable Git Large File Storage (LFS) for a repository.

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.

"Enable Git LFS for a repository" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.
パスパラメーター
名前, Type, 説明
`owner` string 必須 The account owner of the repository. The name is not case sensitive.
`repo` string 必須 The name of the repository. The name is not case sensitive.

"Enable Git LFS for a repository" の HTTP 応答状態コード

状態コード	説明
`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 .

"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

Status: 202

Disable Git LFS for a repository

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

"Disable Git LFS for a repository" のパラメーター

ヘッダー
名前, Type, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.
パスパラメーター
名前, Type, 説明
`owner` string 必須 The account owner of the repository. The name is not case sensitive.
`repo` string 必須 The name of the repository. The name is not case sensitive.

"Disable Git LFS for a repository" の HTTP 応答状態コード

状態コード	説明
`204`	No Content

"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