REST API endpoints for Git LFS

About Git LFS

You can use Git LFS to store large files in a Git repository. The REST API allows you to enable or disable the feature for an individual repository. For more information about Git LFS, see About Git Large File Storage.

People with admin access to a repository can use these endpoints.

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.

Fine-grained access tokens for "Enable Git LFS for a repository"

This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.

Parameters for "Enable Git LFS for a repository"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner` string Required The account owner of the repository. The name is not case sensitive.
`repo` string Required The name of the repository without the `.git` extension. The name is not case sensitive.

HTTP response status codes for "Enable Git LFS for a repository"

Status code	Description
`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 for "Enable Git LFS for a repository"

Request example

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" \
  http(s)://HOSTNAME/api/v3/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.

Fine-grained access tokens for "Disable Git LFS for a repository"

This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.

Parameters for "Disable Git LFS for a repository"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`owner` string Required The account owner of the repository. The name is not case sensitive.
`repo` string Required The name of the repository without the `.git` extension. The name is not case sensitive.

HTTP response status codes for "Disable Git LFS for a repository"

Status code	Description
`204`	No Content

Code samples for "Disable Git LFS for a repository"

Request example

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" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/lfs

Response

Status: 204