2015-06-18 16:27:20 +00:00
|
|
|
# Git LFS API
|
|
|
|
|
|
2016-11-10 20:34:10 +00:00
|
|
|
The Git LFS client uses an HTTPS server to coordinate fetching and storing
|
|
|
|
|
large binary objects separately from a Git server. The basic process the client
|
|
|
|
|
goes through looks like this:
|
|
|
|
|
|
|
|
|
|
1. [Discover the LFS Server to use](./server-discovery.md).
|
|
|
|
|
2. [Apply Authentication](./authentication.md).
|
2017-02-01 23:49:40 +00:00
|
|
|
3. Make the request. See the Batch and File Locking API sections.
|
|
|
|
|
|
|
|
|
|
## Batch API
|
|
|
|
|
|
|
|
|
|
The Batch API is used to request the ability to transfer LFS objects with the
|
|
|
|
|
LFS server.
|
|
|
|
|
|
|
|
|
|
API Specification:
|
|
|
|
|
* [Batch API](./batch.md)
|
2016-11-10 21:47:51 +00:00
|
|
|
|
2016-11-10 20:34:10 +00:00
|
|
|
Current transfer adapters include:
|
2016-11-10 21:47:51 +00:00
|
|
|
* [Basic](./basic-transfers.md)
|
|
|
|
|
|
|
|
|
|
Experimental transfer adapters include:
|
2016-11-10 20:34:10 +00:00
|
|
|
* Tus.io (upload only)
|
2016-11-10 21:47:51 +00:00
|
|
|
* [Custom](../custom-transfers.md)
|
2017-02-01 23:49:40 +00:00
|
|
|
|
|
|
|
|
## File Locking API
|
|
|
|
|
|
|
|
|
|
The File Locking API is used to create, list, and delete locks, as well as
|
|
|
|
|
verify that locks are respected in Git pushes.
|
|
|
|
|
|
|
|
|
|
API Specification:
|
|
|
|
|
* [File Locking API](./locking.md)
|
