-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiary.apib
363 lines (287 loc) · 10 KB
/
apiary.apib
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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
FORMAT: 1A
HOST: http://polls.apiblueprint.org/
# Embedded UI
## Configuration
Unless a user takes action, the REST Interface is enabled by default.
Unless noted, all API calls only work over HTTPS.
All POST requests are done through traditional forms, not JSON. All responses are in JSON.
# Group Unlock
HTTP Enabled
## Unlock Device [POST /core/api/service/unlock.php]
+ Attributes
+ user: charlie (string, required) - API Username
+ password: rocks (string, required) - API Password
+ Key: ABCDEFGH (string) - Unlock code
+ Response 200 (applicaiton/json)
{
"response": {
"mimosaContent": [],
"mimosaStatus": {
"status": 0,
"message": "Command succeeded"
}
}
}
## Get Country Code [GET /core/api/service/unlock.php?user={user}&password={password}]
+ Request (application/json)
+ Parameters
+ user: `charlie` (string, required) - API User name
+ password: `rocks` (required, string) - API Password
+ Response 200 (applicaiton/json)
{
"response": {
"mimosaContent": {
"values": {
"Key": "296"
},
"errors": []
},
"mimosaStatus": {
"status": 0,
"message": "Command succeeded"
}
}
}
# Group Device
## Ethernet [/core/api/service/ethernet.php]
### Set [POST]
+ Attributes
+ user: `charlie` (string, required) - API Username
+ password: `rocks` (string, required) - API Password
+ IPAddressMode: `DHCP` (enum) - Static IP with DHCP or only static
+ Default: `DHCP`
+ Members
+ Static
+ DHCP
+ StaticIP: 192.168.1.20 (string) - Static IP
+ StaticNetmask: 255.255.255.0 (string) - Static Network Mask
+ StaticDNS1: 8.8.8.8 (string) - First DNS server
+ StaticDNS2: 8.8.4.4 (string) - Second DNS server
+ MTU: 60 (number) - Set the MTU
+ RPSmode: `0` (boolean) - Set RPS
+ FlowControl: `0` (boolean) - Set FlowControl
+ Response 200 (application/json)
{
}
### Get [GET /core/api/service/ethernet.php&username={username}&password={password}]
Not only will this return the configured state of the various network interfces, it'll also return the *active* configuration. Meaning it'll give you the current DHCP IP and Static configured IP.
+ Parameters
+ user: `charlie` (string, required) - API User name
+ password: `rocks` (required, string) - API Password
+ Response 200 (application/json)
{
"response": {
"mimosaContent": {
"values": {
"PortSpeed": "Auto",
"SpanningTree": "0",
"IPAddressMode": "DHCP",
"CurrIP": "192.168.1.20",
"CurrNetmask": "255.255.255.0",
"CurrGateway": "192.168.1.1",
"CurrDNS1": "8.8.8.8",
"CurrDNS2": "8.8.4.4",
"StaticIP": "192.168.1.20",
"StaticNetmask": "255.255.255.0",
"StaticGateway": "192.168.1.1",
"StaticDNS1": "8.8.8.8",
"StaticDNS2": "8.8.4.4",
"Curr": {
"IP": "192.168.1.20",
"Netmask": "255.255.255.0",
"Gateway": "192.168.1.1",
"PrimaryDNS": "8.8.8.8",
"SecondaryDNS": "8.8.4.4"
},
"Static": {
"IP": "192.168.1.20",
"Netmask": "255.255.255.0",
"Gateway": "192.168.1.1",
"PrimaryDNS": "8.8.8.8",
"SecondaryDNS": "8.8.4.4"
},
"ActualIP": "192.168.1.20",
"MTU": "1500",
"RPSmode": "0",
"FlowControl": "0"
},
"errors": []
},
"mimosaStatus": {
"status": 0,
"message": "Command succeeded"
}
}
}
## Configuration [/core/api/service/Device.php]
### Set [POST]
+ Attributes
+ user: charlie (string, required) - API Username
+ password: rocks (string, required) - API Password
+ DeviceName: MimosaB5 (string) - Device human friendly name
+ Description: Link between John and Jason (string) - Description of device
+ InstallDate: `2016-07-07` (string) - Installation device
+ Response 200 (application/json)
{
"response": {
"mimosaContent": [],
"mimosaStatus": {
"status": 0,
"message": "Command succeeded"
}
}
}
### Get [GET /core/api/service/Device.php&username={username}&password={password}]
+ Parameters
+ user: `charlie` (string, required) - API User name
+ password: `rocks` (required, string) - API Password
+ Response 200 (application/json)
{
"response": {
"mimosaContent": {
"values": {
"DeviceName": "CharlieAPI",
"Description": "",
"InstallDate": "",
"Model": "C01",
"DeviceMode": "Station",
"SerialNumber": "3011287419",
"Version": "PRIVATE-",
"Country": "United States",
"LastReboot": "2d 18h 41m 42s",
"IPAddress": "192.168.1.20",
"WLANMAC": "20:B5:C6:00:7A:60",
"WANMAC": "",
"GigabitEthernetPort": "20:B5:C6:00:7A:60",
"WirelessMode": "802.11",
"NumberOfAntenna": "2",
"Temperature": "75",
"CableLength": "100",
"BuildDate": "2016-07-22 15:44:45 (UTC -0700)",
"UnlockCode": "CRQF9PK2S"
},
"errors": []
},
"mimosaStatus": {
"status": 0,
"message": "Command succeeded"
}
}
}
## Passwords [/core/api/service/Passwords.php]
The `UserPassword` field has been deprecated but left here in case it is needed in the future.
### Set [POST /core/api/service/Passwords.php]
+ Attributes
+ user: charlie (string, required) - API Username
+ password: rocks (string, required) - API Password
+ SuperPassword: 81dc9bdb52d04dc20036dbd8313ed055 (string) - MD5 hash for UI Password
+ UserPassword: 81dc9bdb52d04dc20036dbd8313ed055 (string) - MD5 has for second account. Unused.
+ Response 200 (application/json)
{
"response": {
"mimosaContent": [],
"mimosaStatus": {
"status": 0,
"message": "Command succeeded"
}
}
}
### Get [GET /core/api/service/Passwords.php?username={username}&password={password}]
+ Parameters
+ user: `charlie` (string, required) - API User name
+ password: `rocks` (required, string) - API Password
+ Response 200 (applicaiton/json)
{
"response": {
"mimosaContent": {
"values": {
"SuperPassword": "c6c19b75b22a359ec6f2090d43d96bf9",
"UserPassword": "c6c19b75b22a359ec6f2090d43d96bf9"
},
"errors": []
},
"mimosaStatus": {
"status": 0,
"message": "Command succeeded"
}
}
}
## Info [/core/api/service/device-info.php]
### Statistics [GET /core/api/service/device-info.php?username={username}&password={password}]
+ Request (application/json)
+ Parameters
+ user: `charlie` (string, required) - API User name
+ password: `rocks` (required, string) - API Password
+ Response 200 (applicaiton/json)
{
"response": {
"mimosaContent": {
"values": {
"DeviceName": "MimosaNorthWest-C5",
"Description": "",
"InstallDate": "",
"Model": "C01",
"DeviceMode": "Station",
"SerialNumber": "3016184803",
"Version": "2.0.1-fcs-5",
"Country": "Mimosa Test",
"LastReboot": "64d 1h 44m 44s",
"IPAddress": "10.1.2.187",
"WLANMAC": "20:B5:C6:01:AC:4B",
"WANMAC": "",
"GigabitEthernetPort": "20:B5:C6:01:AC:4A",
"WirelessMode": "802.11",
"NumberOfAntenna": "2",
"Temperature": "70",
"CableLength": "100",
"BuildDate": "2016-05-10 16:49:02 (UTC +0000)",
"UnlockCode": "NAHNSFDSP"
},
"errors": []
},
"mimosaStatus": {
"status": 0,
"message": "Command succeeded"
}
}
}
# Group Firmware
## Prepare Upgrade Process [POST /core/api/service/firm-prepare.php]
+ Attributes
+ user: charlie (string, required) - API Username
+ password: rocks (string, required) - API Password
+ Prepare: '' (string) - HAS TO BE BLANK STRING
+ Response 200 (application/json)
{
"response": {
"mimosaContent": [],
"mimosaStatus": {
"status": 0,
"message": "Command succeeded"
}
}
}
## Prepare Proccess Status [GET /core/api/service/firm-prepare.php?username={user}&password={password}]
+ Request (application/json)
+ Parameters
+ user: `charlie` (string, required) - API User name
+ password: `rocks` (required, string) - API Password
+ Response 200 (application/json)
{
"response": {
"mimosaContent": {
"values": {
"LoadLicense": "",
"Update": 0,
"Reset": 0,
"Reboot": 0,
"Prepare": 101
},
"errors": []
},
"mimosaStatus": {
"status": 0,
"message": "Command succeeded"
}
}
}