Sonolus Wiki

GET /sonolus/info

/sonolus/info provides information of the server, and is used by Sonolus app to populate server home page.

Query Parameters

Query ParameterValueDescription
localizationstringSee localization.

Request Headers

HeaderValueDescription
Sonolus-SessionstringOptional, see Sonolus-Session.

Request Body

None.

Response Code

CodeDescription
200 OK
401 UnauthorizedAuthentication required or expired.

Response Headers

HeaderValueDescription
Sonolus-VersionstringOptional, see Sonolus-Version.

Response Body

type ServerInfo = {
    title: string
    description?: string
    hasAuthentication: boolean
    hasMultiplayer: boolean
    banner?: SRL
}

Examples

{
    "title": "My Server Title",
    "hasAuthentication": false,
    "hasMultiplayer": true,
    "banner": {
        // ...
    }
}