1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
openapi: 3.0.3
info:
title: Mobius API
description: REST API for managing a Hotline server
version: 1.0.0
contact:
name: Mobius
url: https://github.com/jhalter/mobius
servers:
- url: http://localhost:5603
description: Local development server
security:
- ApiKeyAuth: []
paths:
/api/v1/online:
get:
summary: Get online users
description: Returns a list of currently online users with their login, nickname, and IP address
responses:
'200':
description: List of online users
content:
application/json:
schema:
type: array
items:
type: object
properties:
login:
type: string
description: User's login name
nickname:
type: string
description: User's display nickname
ip:
type: string
description: User's IP address
example:
login: "admin"
nickname: "Administrator"
ip: "192.168.1.100"
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/ban:
post:
summary: Ban a user
description: Ban a user by username, nickname, or IP address. At least one field must be provided.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
username:
type: string
description: Username to ban
nickname:
type: string
description: Nickname to ban
ip:
type: string
description: IP address to ban
example:
username: "baduser"
responses:
'200':
description: User banned successfully
content:
application/json:
schema:
type: object
properties:
msg:
type: string
example: "banned"
'400':
description: Bad request - missing required fields
content:
text/plain:
schema:
type: string
example: "username, nickname, or ip required"
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/unban:
post:
summary: Unban a user
description: Remove a ban for a user by username, nickname, or IP address. At least one field must be provided.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
username:
type: string
description: Username to unban
nickname:
type: string
description: Nickname to unban
ip:
type: string
description: IP address to unban
example:
username: "baduser"
responses:
'200':
description: User unbanned successfully
content:
application/json:
schema:
type: object
properties:
msg:
type: string
example: "unbanned"
'400':
description: Bad request - missing required fields
content:
text/plain:
schema:
type: string
example: "username, nickname, or ip required"
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/banned/ips:
get:
summary: List banned IP addresses
description: Returns a list of all banned IP addresses
responses:
'200':
description: List of banned IP addresses
content:
application/json:
schema:
type: array
items:
type: string
example: ["192.168.1.100", "10.0.0.5"]
'401':
$ref: '#/components/responses/Unauthorized'
'500':
description: Internal server error
content:
text/plain:
schema:
type: string
example: "failed to fetch banned IPs"
/api/v1/banned/usernames:
get:
summary: List banned usernames
description: Returns a list of all banned usernames
responses:
'200':
description: List of banned usernames
content:
application/json:
schema:
type: array
items:
type: string
example: ["baduser", "spammer"]
'401':
$ref: '#/components/responses/Unauthorized'
'500':
description: Internal server error
content:
text/plain:
schema:
type: string
example: "failed to fetch banned usernames"
/api/v1/banned/nicknames:
get:
summary: List banned nicknames
description: Returns a list of all banned nicknames
responses:
'200':
description: List of banned nicknames
content:
application/json:
schema:
type: array
items:
type: string
example: ["BadNick", "Spammer123"]
'401':
$ref: '#/components/responses/Unauthorized'
'500':
description: Internal server error
content:
text/plain:
schema:
type: string
example: "failed to fetch banned nicknames"
/api/v1/reload:
post:
summary: Reload server configuration
description: Triggers a reload of the server configuration
responses:
'200':
description: Configuration reloaded successfully
content:
application/json:
schema:
type: object
properties:
msg:
type: string
example: "config reloaded"
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/shutdown:
post:
summary: Shutdown server
description: Gracefully shutdown the server with a message
requestBody:
required: true
content:
text/plain:
schema:
type: string
example: "Server maintenance"
responses:
'200':
description: Server shutting down
content:
application/json:
schema:
type: object
properties:
msg:
type: string
example: "server shutting down"
'400':
description: Bad request - missing shutdown message
'401':
$ref: '#/components/responses/Unauthorized'
/api/v1/stats:
get:
summary: Get server statistics
description: Returns current server statistics and metrics
responses:
'200':
description: Server statistics
content:
application/json:
schema:
type: object
description: Server statistics object (structure depends on implementation)
'401':
$ref: '#/components/responses/Unauthorized'
'500':
description: Internal server error
content:
text/plain:
schema:
type: string
example: "failed to marshal stats"
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: API key for authentication
responses:
Unauthorized:
description: Authentication required
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "unauthorized"
|
