doc/api/index.textile

   1 ---
   2 layout: default
   3 navsection: api
   4 title: API Reference
   5 navorder: 0
   6 ---
   7
   8 h1. API Reference
   9
  10 h2. Concepts
  11
  12 * Each API uses the same "authentication mechanism":authentication.html.
  13 * Resources in requests and responses adhere to a "common structure":resources.html.
  14 * API transactions use common "REST methods":methods.html.
  15 * API transactions are subject to a "permission model":permission-model.html.
  16 * "Job tasks":job-task.html use some special API features.
  17
  18 h2. Resources
  19
  20 h3. Generic Resources
  21
  22 * "Collections":Collections.html
  23 * "Jobs":Jobs.html
  24 * "JobTasks":JobTasks.html
  25 * "Links":Links.html
  26 * "Log":Log.html
  27 * "PipelineTemplate":PipelineTemplate.html
  28 * "PipelineInstance":PipelineInstance.html
  29 * "Group":Group.html
  30 * "Human":Human.html
  31 * "Specimen":Specimen.html
  32 * "Trait":Trait.html
  33 * "User":User.html
  34
  35 h3. Authentication
  36
  37 These Arvados resources govern authorization and "authentication":authentication.html:
  38
  39 * "ApiClients":ApiClients.html
  40 * "ApiClientAuthorization":ApiClientAuthorization.html
  41 * "AuthorizedKey":AuthorizedKey.html
  42
  43 h3. Arvados Infrastructure
  44
  45 These resources govern the Arvados infrastructure itself: Git repositories, Keep disks, active nodes, etc.
  46
  47 * "CommitAncestor":CommitAncestor.html
  48 * "Commit":Commit.html
  49 * "KeepDisk":KeepDisk.html
  50 * "Node":Node.html
  51 * "Repository":Repository.html
  52 * "VirtualMachine":VirtualMachine.html