docs/api/README.md

   1 # Git LFS API
   2
   3 The Git LFS client uses an HTTPS server to coordinate fetching and storing
   4 large binary objects separately from a Git server. The basic process the client
   5 goes through looks like this:
   6
   7 1. [Discover the LFS Server to use](./server-discovery.md).
   8 2. [Apply Authentication](./authentication.md).
   9 3. Make the request. See the Batch and File Locking API sections.
  10
  11 ## Batch API
  12
  13 The Batch API is used to request the ability to transfer LFS objects with the
  14 LFS server.
  15
  16 API Specification:
  17   * [Batch API](./batch.md)
  18
  19 Current transfer adapters include:
  20   * [Basic](./basic-transfers.md)
  21
  22 Experimental transfer adapters include:
  23   * Tus.io (upload only)
  24   * [Custom](../custom-transfers.md)
  25
  26 ## File Locking API
  27
  28 The File Locking API is used to create, list, and delete locks, as well as
  29 verify that locks are respected in Git pushes.
  30
  31 API Specification:
  32   * [File Locking API](./locking.md)