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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "nodes"
   6
   7 ...
   8
   9 h1. nodes
  10
  11 Required arguments are displayed in %{background:#ccffcc}green%.
  12
  13
  14 h2. create
  15
  16 Create a new Node.
  17
  18 Arguments:
  19
  20 table(table table-bordered table-condensed).
  21 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  22 |node|object||query||
  23
  24 h2. delete
  25
  26 Delete an existing Node.
  27
  28 Arguments:
  29
  30 table(table table-bordered table-condensed).
  31 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  32 {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
  33
  34 h2. destroy
  35
  36 destroy nodes
  37
  38 Arguments:
  39
  40 table(table table-bordered table-condensed).
  41 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  42 {background:#ccffcc}.|uuid|string||path||
  43
  44 h2. get
  45
  46 Gets a Node'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 Node in question.|path||
  53
  54 h2. index
  55
  56 index nodes
  57
  58 Arguments:
  59
  60 table(table table-bordered table-condensed).
  61 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  62 |order|string||query||
  63 |where|object||query||
  64
  65 h2. list
  66
  67 List nodes.
  68
  69 Arguments:
  70
  71 table(table table-bordered table-condensed).
  72 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  73 |limit|integer (default 100)|Maximum number of nodes to return.|query||
  74 |order|string|Order in which to return matching nodes.|query||
  75 |pageToken|string|Page token.|query||
  76 |q|string|Query string for searching nodes.|query||
  77 |where|object|Conditions for filtering nodes.|query||
  78
  79 h2. ping
  80
  81 ping nodes
  82
  83 Arguments:
  84
  85 table(table table-bordered table-condensed).
  86 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  87 {background:#ccffcc}.|ping_secret|string||query||
  88 {background:#ccffcc}.|uuid|string||path||
  89
  90 h2. show
  91
  92 show nodes
  93
  94 Arguments:
  95
  96 table(table table-bordered table-condensed).
  97 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  98 {background:#ccffcc}.|uuid|string||path||
  99
 100 h2. update
 101
 102 Update attributes of an existing Node.
 103
 104 Arguments:
 105
 106 table(table table-bordered table-condensed).
 107 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 108 {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
 109 |node|object||query||