Sonolus Wiki

GET /sonolus/info

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

URL Parameters

None.

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
    buttons: ServerInfoButton[]
    banner?: SRL
}

type ServerInfoButton = {
    type:
        | 'authentication'
        | 'multiplayer'
        | 'post'
        | 'playlist'
        | 'level'
        | 'replay'
        | 'skin'
        | 'background'
        | 'effect'
        | 'particle'
        | 'engine'
}

Examples

{
    "title": "My Server Title",
    "description": "Description of my server.",
    "buttons": [
        // ...
    ],
    "banner": {
        // ...
    }
}