github.com/kardianos/nomad@v0.1.3-0.20151022182107-b13df73ee850/website/source/docs/http/agent-join.html.md (about)

     1  ---
     2  layout: "http"
     3  page_title: "HTTP API: /v1/agent/join"
     4  sidebar_current: "docs-http-agent-join"
     5  description: |-
     6    The '/1/agent/join' endpoint is used to cluster the Nomad servers.
     7  ---
     8  
     9  # /v1/agent/join
    10  
    11  The `join` endpoint is used to cluster the Nomad servers using a gossip pool.
    12  The servers participate in a peer-to-peer gossip, and `join` is used to introduce
    13  a member to the pool. This is only applicable for servers.
    14  
    15  ## PUT / POST
    16  
    17  <dl>
    18    <dt>Description</dt>
    19    <dd>
    20      Initiate a join between the agent and target peers.
    21    </dd>
    22  
    23    <dt>Method</dt>
    24    <dd>PUT or POST</dd>
    25  
    26    <dt>URL</dt>
    27    <dd>`/v1/agent/join`</dd>
    28  
    29    <dt>Parameters</dt>
    30    <dd>
    31      <ul>
    32        <li>
    33          <span class="param">address</span>
    34          <span class="param-flags">required</span>
    35          The address to join. Can be provided multiple times
    36          to attempt joining multiple peers.
    37        </li>
    38      </ul>
    39    </dd>
    40  
    41    <dt>Returns</dt>
    42    <dd>
    43  
    44      ```javascript
    45      {
    46      "num_joined": 1,
    47      "error": ""
    48      }
    49      ```
    50  
    51    </dd>
    52  </dl>
    53