Skip to main content

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the new Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks REST API pages.

Git LFS

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

Git LFS について

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

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

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>" \ https://HOSTNAME/api/v3/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>" \ https://HOSTNAME/api/v3/repos/OWNER/REPO/lfs

Response

Status: 204