server_update
Change how the server presents itself: its name, icon, and banner. Every connected client is told about the change, so they can update their server list at once.
Request
Section titled “Request”{ "cmd": "server_update", "name": "My community", "icon": "https://cdn.example.com/icon.png"}| Field | Type | Required | Description |
|---|---|---|---|
name |
string | No | New server name. Can’t be empty or null. |
icon |
string or null | No | An http:// or https:// URL, or the file name of a server asset. null or "" clears the icon. |
banner |
string or null | No | Same rules as icon. |
Send at least one field. Fields you leave out stay as they are.
A value that isn’t a URL is treated as a server asset name and served from <server.url>/server-assets/<name>. The server doesn’t check that the asset exists. To upload the image bytes first, use the server asset endpoint.
Response
Section titled “Response”{ "cmd": "server_update", "name": "My community", "icon": "https://cdn.example.com/icon.png", "banner": "https://chat.example.com/server-assets/banner.png"}The response always has all three fields. Asset names come back as full URLs, and a cleared image is "".
Every other authenticated connection receives the same frame, without your listener. The change is recorded in the audit log.
Permissions
Section titled “Permissions”Requires manage_server. Fields locked by the hosting plan can’t be changed. It is blocked while you are timed out.
Errors
Section titled “Errors”val |
When |
|---|---|
No updates provided |
None of name, icon, or banner was sent. |
Config value 'server.name' must be a non-empty string |
name is empty, blank, or null. |
These settings are managed by your hosting plan: <paths> |
A field you sent is locked by the host. |
Failed to write config to disk |
The server couldn’t save config.json. |
| Validation message | A field has the wrong type, for example name: Expected string, received number. |
