REST API はバージョン管理になりました。 詳細については、「API のバージョン管理について」を参照してください。

Git LFS の REST API エンドポイント

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

Git LFS について

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

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

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

Organization に属するリポジトリにこれらのエンドポイントを使う場合は、そのリポジトリへの管理アクセス権が必要です (Organization オーナーとして継承されていることがあります)。また、自分のロールにも、Organization の請求先へのアクセス権が必要です。

  • リポジトリが GitHub Team 上の Organization によって所有されている場合、Organization オーナーまたは課金マネージャーである必要があります。 詳細については、「Organizationのロール」を参照してください。
  • リポジトリが、GitHub Enterprise Cloud 上の Organization によって所有されており、Enterprise アカウントによって所有されていない場合、Organization オーナーまたは課金マネージャーである必要があります。 詳しくは、「Organizationのロール」を参照してください。
  • リポジトリが Enterprise アカウントによって所有されている Organization によって所有されている場合は、Enterprise 所有者または課金マネージャーである必要があります。 詳しくは、「エンタープライズにおける役割」を参照してください。

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.

"Enable Git LFS for a repository" のきめ細かいアクセス トークン

このエンドポイントは、GitHub アプリのユーザー アクセス トークン、GitHub アプリのインストール アクセス トークン、またはきめ細かい個人用アクセス トークンでは機能しません。

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

ヘッダー
accept string

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

パス パラメーター
owner string 必須

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

repo string 必須

The name of the repository without the .git extension. 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" のコード サンプル

GHE.com で GitHub にアクセスする場合は、api.github.com を api.SUBDOMAIN.ghe.com にあるエンタープライズの専用サブドメインに置き換えます。

要求の例

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.

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

"Disable Git LFS for a repository" のきめ細かいアクセス トークン

このエンドポイントは、GitHub アプリのユーザー アクセス トークン、GitHub アプリのインストール アクセス トークン、またはきめ細かい個人用アクセス トークンでは機能しません。

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

ヘッダー
accept string

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

パス パラメーター
owner string 必須

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

repo string 必須

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

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

状態コード説明
204

No Content

"Disable Git LFS for a repository" のコード サンプル

GHE.com で GitHub にアクセスする場合は、api.github.com を api.SUBDOMAIN.ghe.com にあるエンタープライズの専用サブドメインに置き換えます。

要求の例

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