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 Parameter | Value | Description |
|---|---|---|
localization | string | See localization. |
| Configuration Options | any | See Options Query Parameters. |
Request Headers
| Header | Value | Description |
|---|---|---|
Sonolus-Session | string | Optional, see Sonolus-Session. |
Request Body
None.
Response Code
| Code | Description |
|---|---|
200 OK | |
401 Unauthorized | Authentication required or expired. |
Response Headers
| Header | Value | Description |
|---|---|---|
Sonolus-Version | string | Optional, see Sonolus-Version. |
Response Body
type ServerInfo = {
title: string
description?: string
buttons: ServerInfoButton[]
configuration: ServerConfiguration
banner?: Srl
}
type ServerInfoButton = {
type:
| 'authentication'
| 'multiplayer'
| 'post'
| 'playlist'
| 'level'
| 'replay'
| 'skin'
| 'background'
| 'effect'
| 'particle'
| 'engine'
| 'configuration'
}
type ServerConfiguration = {
options: ServerOption[]
}
configuration.options
Configuration options.
If modified by client, client will attach modified values to every request.
Examples
{
"title": "My Server Title",
"description": "Description of my server.",
"buttons": [
// ...
],
"configuration": {
"options": [
// ...
]
},
"banner": {
// ...
}
}