Create a one-time join token for an agent
POST
/api/v1/join-tokens
const url = 'http://localhost:8080/api/v1/join-tokens';const options = { method: 'POST', headers: { cookie: 'brokerium_session=<brokerium_session>', 'X-Brokerium-Request': '1', 'Content-Type': 'application/json' }, body: '{"nodeName":"example","clusterId":"example","ttlMinutes":60}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:8080/api/v1/join-tokens \ --header 'Content-Type: application/json' \ --header 'X-Brokerium-Request: 1' \ --cookie brokerium_session=<brokerium_session> \ --data '{ "nodeName": "example", "clusterId": "example", "ttlMinutes": 60 }'Role: operator. Returns the install command for the host.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”X-Brokerium-Request
required
string
Required on every non-GET request.
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
nodeName
required
string
clusterId
string | null
ttlMinutes
integer
Responses
Section titled “Responses”Token and install command.
Media typeapplication/json
object
token
required
string
expiresAt
required
string format: date-time
command
required
string
Example generated
{ "token": "example", "expiresAt": "2026-04-15T12:00:00Z", "command": "example"}Apache®, Apache Kafka® and Kafka® are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries. Brokerium is not affiliated with, endorsed by, or sponsored by the Apache Software Foundation.