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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "virtual_machines"
   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/virtual_machines@
  12
  13 Required arguments are displayed in %{background:#ccffcc}green%.
  14
  15
  16 h2. create
  17
  18 Create a new VirtualMachine.
  19
  20 Arguments:
  21
  22 table(table table-bordered table-condensed).
  23 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  24 |virtual_machine|object||query||
  25
  26 h2. delete
  27
  28 Delete an existing VirtualMachine.
  29
  30 Arguments:
  31
  32 table(table table-bordered table-condensed).
  33 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  34 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
  35
  36 h2. get
  37
  38 Gets a VirtualMachine's metadata by UUID.
  39
  40 Arguments:
  41
  42 table(table table-bordered table-condensed).
  43 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  44 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
  45
  46 h2. get_all_logins
  47
  48 get_all_logins virtual_machines
  49
  50 Arguments:
  51
  52 table(table table-bordered table-condensed).
  53 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  54
  55 h2. list
  56
  57 List virtual_machines.
  58
  59 Arguments:
  60
  61 table(table table-bordered table-condensed).
  62 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  63 |limit|integer (default 100)|Maximum number of virtual_machines to return.|query||
  64 |order|string|Order in which to return matching virtual_machines.|query||
  65 |filters|array|Conditions for filtering virtual_machines.|query||
  66
  67 h2. logins
  68
  69 logins virtual_machines
  70
  71 Arguments:
  72
  73 table(table table-bordered table-condensed).
  74 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  75 {background:#ccffcc}.|uuid|string||path||
  76
  77 h2. update
  78
  79 Update attributes of an existing VirtualMachine.
  80
  81 Arguments:
  82
  83 table(table table-bordered table-condensed).
  84 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  85 {background:#ccffcc}.|uuid|string|The UUID of the VirtualMachine in question.|path||
  86 |virtual_machine|object||query||