doc/api/methods/keep_services.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "keep_services"
   6
   7 ...
   8
   9 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  10
  11 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/keep_services@
  12
  13 Required arguments are displayed in %{background:#ccffcc}green%.
  14
  15 h2. accessible
  16
  17 Get a list of keep services that are accessible to the requesting client.  This
  18 is context-sensitive, for example providing the list of actual Keep servers
  19 when inside the cluster, but providing a proxy service if client contacts
  20 Arvados from outside the cluster.
  21
  22 Takes no arguments.
  23
  24 h2. create
  25
  26 Create a new KeepService.
  27
  28 Arguments:
  29
  30 table(table table-bordered table-condensed).
  31 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  32 |keep_disk|object||query||
  33
  34 h2. delete
  35
  36 Delete an existing KeepService.
  37
  38 Arguments:
  39
  40 table(table table-bordered table-condensed).
  41 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  42 {background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||
  43
  44 h2. get
  45
  46 Gets a KeepService's metadata by UUID.
  47
  48 Arguments:
  49
  50 table(table table-bordered table-condensed).
  51 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  52 {background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||
  53
  54 h2. list
  55
  56 List keep_services.
  57
  58 Arguments:
  59
  60 table(table table-bordered table-condensed).
  61 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  62 |limit|integer (default 100)|Maximum number of keep_services to return.|query||
  63 |order|string|Order in which to return matching keep_services.|query||
  64 |filters|array|Conditions for filtering keep_services.|query||
  65
  66 h2. update
  67
  68 Update attributes of an existing KeepService.
  69
  70 Arguments:
  71
  72 table(table table-bordered table-condensed).
  73 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  74 {background:#ccffcc}.|uuid|string|The UUID of the KeepService in question.|path||
  75 |keep_service|object||query||