AdminServerService
Chatto exposes this service below /api/connect.
Shared message and enum definitions are documented in Shared Types And Enums.
AdminServerService
Section titled “AdminServerService”Provides server-administration commands for profile, branding, and security settings.
GetServerConfig
Section titled “GetServerConfig”Gets runtime-editable server settings. This RPC requires server.manage.
POST /api/connect/chatto.admin.v1.AdminServerService/GetServerConfigInput: GetServerConfigRequest
Section titled “Input: GetServerConfigRequest”Request runtime-editable server settings; requires server.manage.
Result: GetServerConfigResponse
Section titled “Result: GetServerConfigResponse”Server settings plus effective public branding.
| Field | Type | Description |
|---|---|---|
config | ServerConfig | Runtime-editable server settings. |
public_profile | chatto.api.v1.ServerPublicProfile | Effective public server profile and branding. |
UpdateServerConfig
Section titled “UpdateServerConfig”Updates runtime-editable server settings. This RPC requires server.manage.
POST /api/connect/chatto.admin.v1.AdminServerService/UpdateServerConfigInput: UpdateServerConfigRequest
Section titled “Input: UpdateServerConfigRequest”Request to update runtime-editable server settings; requires server.manage.
| Field | Type | Description |
|---|---|---|
server_name | optional string | Optional server name for page titles. Set to empty string to use default. |
description | optional string | Optional short server description for OG link-preview metadata. Set to empty string to clear. |
motd | optional string | Optional message of the day for the header. Set to empty string to clear. |
welcome_message | optional string | Optional welcome message shown on the login page. Set to empty string to clear. |
registration | RegistrationSettingsUpdate | Partial account creation settings; requires server.manage. |
update_mask | google.protobuf.FieldMask | Editable fields to apply or reset: server_name, description, motd, welcome_message, registration.admission. Omit to infer populated fields; * selects all editable fields. An explicit empty mask is invalid. Unselected values are ignored. Selected absent values reset the field to its default, subject to field validation. |
Result: UpdateServerConfigResponse
Section titled “Result: UpdateServerConfigResponse”Result of updating runtime-editable server settings.
| Field | Type | Description |
|---|---|---|
public_profile | chatto.api.v1.ServerPublicProfile | Updated public server profile and branding. |
config | ServerConfig | Updated runtime-editable server settings. |
UploadServerLogo
Section titled “UploadServerLogo”Uploads and sets the public server logo. This RPC requires server.manage.
POST /api/connect/chatto.admin.v1.AdminServerService/UploadServerLogoInput: UploadServerLogoRequest
Section titled “Input: UploadServerLogoRequest”Request to upload and set the public server logo.
| Field | Type | Description |
|---|---|---|
image | chatto.api.v1.ImageUpload | Image payload. The server validates, resizes, and stores a WebP logo. |
Result: UploadServerLogoResponse
Section titled “Result: UploadServerLogoResponse”Result of uploading the public server logo.
| Field | Type | Description |
|---|---|---|
public_profile | chatto.api.v1.ServerPublicProfile | Updated public server profile and branding. |
DeleteServerLogo
Section titled “DeleteServerLogo”Clears the public server logo. This RPC requires server.manage.
POST /api/connect/chatto.admin.v1.AdminServerService/DeleteServerLogoInput: DeleteServerLogoRequest
Section titled “Input: DeleteServerLogoRequest”Request to clear the public server logo.
Result: DeleteServerLogoResponse
Section titled “Result: DeleteServerLogoResponse”Result of clearing the public server logo.
| Field | Type | Description |
|---|---|---|
public_profile | chatto.api.v1.ServerPublicProfile | Updated public server profile and branding. |
UploadServerBanner
Section titled “UploadServerBanner”Uploads and sets the public server banner. This RPC requires server.manage.
POST /api/connect/chatto.admin.v1.AdminServerService/UploadServerBannerInput: UploadServerBannerRequest
Section titled “Input: UploadServerBannerRequest”Request to upload and set the public server banner.
| Field | Type | Description |
|---|---|---|
image | chatto.api.v1.ImageUpload | Image payload. The server validates, resizes, and stores a WebP banner. |
Result: UploadServerBannerResponse
Section titled “Result: UploadServerBannerResponse”Result of uploading the public server banner.
| Field | Type | Description |
|---|---|---|
public_profile | chatto.api.v1.ServerPublicProfile | Updated public server profile and branding. |
DeleteServerBanner
Section titled “DeleteServerBanner”Clears the public server banner. This RPC requires server.manage.
POST /api/connect/chatto.admin.v1.AdminServerService/DeleteServerBannerInput: DeleteServerBannerRequest
Section titled “Input: DeleteServerBannerRequest”Request to clear the public server banner.
Result: DeleteServerBannerResponse
Section titled “Result: DeleteServerBannerResponse”Result of clearing the public server banner.
| Field | Type | Description |
|---|---|---|
public_profile | chatto.api.v1.ServerPublicProfile | Updated public server profile and branding. |
GetServerSecurityConfig
Section titled “GetServerSecurityConfig”Returns security-sensitive server configuration. This RPC requires server.manage.
POST /api/connect/chatto.admin.v1.AdminServerService/GetServerSecurityConfigInput: GetServerSecurityConfigRequest
Section titled “Input: GetServerSecurityConfigRequest”Request for server security configuration.
Result: GetServerSecurityConfigResponse
Section titled “Result: GetServerSecurityConfigResponse”Security-sensitive server configuration. The caller must be allowed to manage server configuration.
| Field | Type | Description |
|---|---|---|
blocked_usernames | repeated string | Blocked usernames. Entries are normalized by the server. |
UpdateBlockedUsernames
Section titled “UpdateBlockedUsernames”Updates the blocked-username list. This RPC requires server.manage.
POST /api/connect/chatto.admin.v1.AdminServerService/UpdateBlockedUsernamesInput: UpdateBlockedUsernamesRequest
Section titled “Input: UpdateBlockedUsernamesRequest”Request to update the server blocked-username list.
| Field | Type | Description |
|---|---|---|
blocked_usernames | repeated string | Complete replacement list. Select blocked_usernames in update_mask and omit this field or send [] to clear the list. Empty entries are ignored and entries are normalized by the server. |
update_mask | google.protobuf.FieldMask | Editable fields to apply or reset: blocked_usernames. Omit to infer populated fields; * selects all editable fields. An explicit empty mask is invalid. Unselected values are ignored. Selected absent values reset the field to its default, subject to field validation. |
Result: UpdateBlockedUsernamesResponse
Section titled “Result: UpdateBlockedUsernamesResponse”Result of updating the server blocked-username list.
| Field | Type | Description |
|---|---|---|
blocked_usernames | repeated string | Effective blocked usernames after the update. |
ListNeighbors
Section titled “ListNeighbors”Lists configured Neighbors. This RPC requires server.manage-neighbors.
POST /api/connect/chatto.admin.v1.AdminServerService/ListNeighborsInput: ListNeighborsRequest
Section titled “Input: ListNeighborsRequest”Request to list configured Neighbors.
Result: ListNeighborsResponse
Section titled “Result: ListNeighborsResponse”Configured Neighbors. The response has no ordering contract.
| Field | Type | Description |
|---|---|---|
neighbors | repeated Neighbor | No field description provided. |
GetNeighbor
Section titled “GetNeighbor”Gets one configured Neighbor. This RPC requires server.manage-neighbors.
POST /api/connect/chatto.admin.v1.AdminServerService/GetNeighborInput: GetNeighborRequest
Section titled “Input: GetNeighborRequest”Request for one configured Neighbor.
| Field | Type | Description |
|---|---|---|
neighbor_id | string | No field description provided. |
Result: GetNeighborResponse
Section titled “Result: GetNeighborResponse”One configured Neighbor.
| Field | Type | Description |
|---|---|---|
neighbor | Neighbor | No field description provided. |
CreateNeighbor
Section titled “CreateNeighbor”Advertises one server origin. The origin must not identify this server. This RPC requires server.manage-neighbors.
POST /api/connect/chatto.admin.v1.AdminServerService/CreateNeighborInput: CreateNeighborRequest
Section titled “Input: CreateNeighborRequest”Request to advertise one server origin.
| Field | Type | Description |
|---|---|---|
origin | string | No field description provided. |
Result: CreateNeighborResponse
Section titled “Result: CreateNeighborResponse”Newly configured Neighbor.
| Field | Type | Description |
|---|---|---|
neighbor | Neighbor | No field description provided. |
UpdateNeighbor
Section titled “UpdateNeighbor”Changes one advertised server origin. The new origin must not identify this server. This RPC requires server.manage-neighbors.
POST /api/connect/chatto.admin.v1.AdminServerService/UpdateNeighborInput: UpdateNeighborRequest
Section titled “Input: UpdateNeighborRequest”Request to change one advertised server origin.
| Field | Type | Description |
|---|---|---|
neighbor_id | string | No field description provided. |
origin | string | No field description provided. |
revision | string | No field description provided. |
update_mask | google.protobuf.FieldMask | Editable fields to apply or reset: origin. Omit to infer populated fields; * selects all editable fields. An explicit empty mask is invalid. Unselected values are ignored. Selected absent values reset the field to its default, subject to field validation. |
Result: UpdateNeighborResponse
Section titled “Result: UpdateNeighborResponse”Updated Neighbor.
| Field | Type | Description |
|---|---|---|
neighbor | Neighbor | No field description provided. |
DeleteNeighbor
Section titled “DeleteNeighbor”Stops advertising one server origin. This RPC requires server.manage-neighbors.
POST /api/connect/chatto.admin.v1.AdminServerService/DeleteNeighborInput: DeleteNeighborRequest
Section titled “Input: DeleteNeighborRequest”Request to stop advertising one server origin.
| Field | Type | Description |
|---|---|---|
neighbor_id | string | No field description provided. |
revision | string | No field description provided. |
Result: DeleteNeighborResponse
Section titled “Result: DeleteNeighborResponse”Empty result after a Neighbor is deleted.