Add federated server

Add a new federated server. The Search public rooms endpoint will also return public rooms from this server.
URL
Requires Auth
HTTP Method
/api/v1/federation/addServerByUser
yes
POST
Payload
Argument
Example
Required
Description
serverName
my-server.rocket.chat
Required
The public server name.
Example payload
{
  "serverName": "my-server.rocket.chat"
}
Example Call
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -X POST \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/federation/addServerByUser \
    -d '{"serverName": "my-server.rocket.chat"}'
Example Result
Success
{
  "success": true
}
Error 
Any of the following errors can occur on the endpoint.
Authorization: Requires an authentication token for the request to be made.
Already Added: Occurs when the server has already been added.
Invalid Server Name: This occurs when the server name is invalid.
Authorization
Already Added
Invalid Server Name
 {
    "status": "error",
    "message": "You must be logged in to do this."
}
{
    "success": false,
    "error": "already-a-default-server"
}
{
    "success": false,
    "error": "invalid-server-name"
}
Change Log
Version
Description
6.0.0
Added

URL	Requires Auth	HTTP Method
`/api/v1/federation/addServerByUser`	`yes`	`POST`

Argument	Example	Required	Description
`serverName`	`my-server.rocket.chat`	Required	The public server name.

Version	Description
6.0.0	Added

Last modified 2mo ago