Skip to content

Commit 2d9e1d1

Browse files
authored
Merge pull request #17 from Gee-64/G/feature/api-doc-updates
Update API documentation
2 parents 2e553f4 + d573f9b commit 2d9e1d1

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

api/api_calls.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,17 @@ instance, look like this::
3737
"errors": []
3838
}
3939

40+
Starting from Ultimate firmware version 3.12 it is possible to configure a
41+
*"Network Password"*. If a non-empty password is set then most network services
42+
of the Ultimate require the correct password to be supplied in order to be
43+
allowed access.
44+
45+
For the REST API the password must be sent using an additional custom HTTP
46+
header: ``X-Password: <your-password>``. The header must be included in all
47+
requests to all API routes. If the header is missing or has an incorrect
48+
password then a HTTP status code of ``403 Forbidden`` will be returned and no
49+
further action taken. Supplying the header when no *"Network Password"* has
50+
been set is allowed (the header will be ignored).
4051

4152

4253
Routes
@@ -59,6 +70,19 @@ About
5970
"version": "0.1",
6071
"errors": []
6172
}
73+
* - ``GET /v1/info``
74+
-
75+
- Returns some basic information about the Ultimate device::
76+
77+
{
78+
"product": "Ultimate 64",
79+
"firmware_version": "3.12",
80+
"fpga_version": "11F",
81+
"core_version": "143", # Only for Ultimate 64 devices
82+
"hostname": "Terakura",
83+
"errors": []
84+
}
85+
6286

6387
Runners
6488
~~~~~~~
@@ -273,6 +297,9 @@ Machine
273297
* - ``PUT /v1/machine:poweroff``
274298
-
275299
- This U64-only command causes the machine to power off. Note that it is likely that you won't receive a valid response.
300+
* - ``PUT /v1/machine:menu_button``
301+
-
302+
- This command does the same thing as pressing the Menu button on an 1541 Ultimate cartridge, or briefly pressing the Multi Button on the Ultimate 64. The system will either enter or exit the Ultimate menu system depending on it's current state.
276303
* - ``PUT /v1/machine:writemem``
277304
- | *address*
278305
| *data*

0 commit comments

Comments
 (0)