nomad/website/source/docs/http/agent-join.html.md

layout, page_title, sidebar_current, description

layout	page_title	sidebar_current	description
http	HTTP API: /v1/agent/join	docs-http-agent-join	The '/1/agent/join' endpoint is used to cluster the Nomad servers.

/v1/agent/join

The join endpoint is used to cluster the Nomad servers using a gossip pool. The servers participate in a peer-to-peer gossip, and join is used to introduce a member to the pool. This is only applicable for servers.

PUT / POST

Description

Initiate a join between the agent and target peers.

Method

PUT or POST

URL

`/v1/agent/join`

Parameters

• address required The address to join. Can be provided multiple times to attempt joining multiple peers.

Returns

```javascript
{
"num_joined": 1,
"error": ""
}
```