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-Session-IdstringOptional, see Sonolus-Session-Id.
Sonolus-Session-DatastringOptional, see Sonolus-Session-Data.

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
    banner: SRL<'ServerBanner'>
    levels: Section<LevelItem>
    skins: Section<SkinItem>
    backgrounds: Section<BackgroundItem>
    effects: Section<EffectItem>
    particles: Section<ParticleItem>
    engines: Section<EngineItem>
}

type Section<T> = {
    items: T[]
    search: Search
}

Examples

{
    "title": "My Server Title",
    "banner": {
        // ...
    }
    "levels": {
        "items": [
            // ...
        ],
        "search": {
            // ...
        }
    },
    "skins": {
        "items": [
            // ...
        ],
        "search": {
            // ...
        }
    },
    "backgrounds": {
        "items": [
            // ...
        ],
        "search": {
            // ...
        }
    },
    "effects": {
        "items": [
            // ...
        ],
        "search": {
            // ...
        }
    },
    "particles": {
        "items": [
            // ...
        ],
        "search": {
            // ...
        }
    },
    "engines": {
        "items": [
            // ...
        ],
        "search": {
            // ...
        }
    }
}

Remarks

It is recommended to keep each category short by showing only 5 entries.