Get Federated Servers
- Print
- DarkLight
- PDF
Get Federated Servers
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/federation/listServersByUser
Lists all the servers the user has already saved.
Changelog
| 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
Responses
200
OK
Success Example
{
"servers": [
{
"name": "my-local.server",
"default": true,
"local": true
},
{
"name": "matrix.org",
"default": true,
"local": false
},
{
"name": "gitter.im",
"default": true,
"local": false
},
{
"name": "libera.chat",
"default": true,
"local": false
},
{
"name": "my-added-server.rocket.chat",
"default": false,
"local": false
}
],
"success": true
}object
servers
Array of object
object
name
string
default
boolean
local
boolean
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?