Add Federated Server

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/api/v1/federation/addServerByUser

Add a new federated server.

Version	Description
6.0.0	Added

Header parameters

X-User-Id

stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC

X-Auth-Token

stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE

Body parameters

Example 1

{
  "serverName": "my-server.rocket.chat"
}

object

serverName

string Required

The public server name.

Responses

200

Success

{
  "success": true
}

object

success

boolean

401

Unauthorized

Authorization Error

{
  "status": "error",
  "message": "You must be logged in to do this."
}

object

status

string

message

string