mirror of https://github.com/pikvm/pikvm.git
Cleanup Responses subsections, we'll do it differently
This commit is contained in:
Aleksandr Prokudin
parent
b59e0895d4
commit
98ecba3581
358
docs/api.md
358
docs/api.md
|
|
@ -203,14 +203,6 @@ $ curl -k -u admin:admin https://<pikvm-ip>/api/info?fields=hw
|
|||
|
||||
Each category is represented by its own event in the websocket (`info_hw_state`, `info_system_state`, etc). The event content has the same format as the category content in the API.
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Get system log
|
||||
|
||||
**Method**: `GET`
|
||||
|
|
@ -236,14 +228,6 @@ $ curl -k -u admin:admin 'https://<pikvm-ip>/api/log?follow=1&seek=3600'
|
|||
[2025-06-10 22:38:15 kvmd.service] --- kvmd.apps.kvmd.auth INFO --- Authorized user 'admin' via auth service 'htpasswd'
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
-----
|
||||
## HID
|
||||
|
||||
|
|
@ -310,14 +294,6 @@ $ curl -k -u admin:admin https://<pikvm-ip>/api/hid
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Set parameters
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -350,14 +326,6 @@ $ curl -k -X POST \
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Set the connected state
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -388,14 +356,6 @@ $ curl -k -X POST \
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Reset devices' state
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -420,14 +380,6 @@ $ curl -k -X POST -u admin:admin https://<pikvm-ip>/api/hid/reset
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Get keyboard layouts
|
||||
|
||||
**Method**: `GET`
|
||||
|
|
@ -494,14 +446,6 @@ $ curl -k -u admin:admin https://<pikvm-ip>/api/hid/keymaps
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Type text remotely
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -535,14 +479,6 @@ $ curl -k -X POST \
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Send a keyboard shortcut
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -573,14 +509,6 @@ $ curl -k -X POST \
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Send a single key event
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -613,14 +541,6 @@ $ curl -k -X POST \
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Send mouse button events
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -652,14 +572,6 @@ $ curl -k -X POST \
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Move the mouse pointer
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -691,14 +603,6 @@ $ curl -k -X POST \
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Move the mouse ppinter relatively
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -730,14 +634,6 @@ $ curl -k -X POST \
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Send mouse wheel scroll events
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -769,14 +665,6 @@ $ curl -k -X POST \
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
-----
|
||||
## ATX power management
|
||||
|
||||
|
|
@ -817,14 +705,6 @@ $ curl -k -u admin:admin https://<pikvm-ip>/api/atx
|
|||
}
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Set ATX power
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -852,13 +732,6 @@ $ curl -k -X POST \
|
|||
```json
|
||||
FIXME
|
||||
```
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Click ATX button
|
||||
|
||||
|
|
@ -888,14 +761,6 @@ $ curl -k -X POST \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
-----
|
||||
## Mass Storage Drive
|
||||
|
||||
|
|
@ -953,14 +818,6 @@ $ curl -k -u admin:admin https://<pikvm-ip>/api/msd
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Upload MSD image
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1028,14 +885,6 @@ $ curl -v -X POST -k \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Set MSD parameters
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1065,14 +914,6 @@ $ curl -X POST -k \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Control MSD
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1100,14 +941,6 @@ $ curl -X POST -k \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Remove MSD image
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1135,14 +968,6 @@ $ curl -X POST -k \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Reset MSD
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1166,14 +991,6 @@ $ curl -X POST -k \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
-----
|
||||
## GPIO
|
||||
|
||||
|
|
@ -1248,14 +1065,6 @@ $ curl -k -u admin:admin https://<pikvm-ip>/api/gpio
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Switch GPIO channel
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1289,14 +1098,6 @@ $ curl -k -X POST \
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Pulse GPIO channel
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1327,14 +1128,6 @@ $ curl -k -X POST \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
----
|
||||
## Streamer
|
||||
|
||||
|
|
@ -1398,14 +1191,6 @@ $ curl -k -u admin:admin https://<pikvm-ip>/api/streamer
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Take snapshot
|
||||
|
||||
**Method**: `GET`
|
||||
|
|
@ -1483,14 +1268,6 @@ $ curl -k -X DELETE \
|
|||
}⏎
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Get OCR state
|
||||
|
||||
**Method**: GET
|
||||
|
|
@ -1512,14 +1289,6 @@ $ curl -k -u admin:admin https://<pikvm-ip>/api/streamer/ocr
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
----
|
||||
## Switch
|
||||
|
||||
|
|
@ -1551,14 +1320,6 @@ $ curl -k -u admin:admin https://<pikvm-ip>/api/switch
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Set active port (previous)
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1582,14 +1343,6 @@ $ curl -k -X POST \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Set active port (next)
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1613,14 +1366,6 @@ $ curl -k -X POST \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Set active port (specific)
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1648,14 +1393,6 @@ $ curl -k -X POST \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Set beacon
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1686,14 +1423,6 @@ $ curl -k -X POST \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Set port parameters
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1727,14 +1456,6 @@ $ curl -k -X POST \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Set beacon color
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1763,14 +1484,6 @@ $ curl -k -X POST \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Reboot the device
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1799,14 +1512,6 @@ $ curl -k -X POST \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Create a new EDID configuration
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1835,14 +1540,6 @@ $ curl -k -X POST \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Change EDID configuration
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1873,14 +1570,6 @@ $ curl -k -X POST \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Remove EDID configuration
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1908,14 +1597,6 @@ $ curl -k -X POST \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### ATX Power Control
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1944,14 +1625,6 @@ $ curl -k -X POST \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### ATX Button Click
|
||||
|
||||
**Method**: `POST`
|
||||
|
|
@ -1980,14 +1653,6 @@ $ curl -k -X POST \
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
----
|
||||
## Redfish
|
||||
|
||||
|
|
@ -2016,14 +1681,6 @@ $ curl -k https://<pikvm-ip>/api/redfish/v1
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Systems collection
|
||||
|
||||
**Method**: `GET`
|
||||
|
|
@ -2045,14 +1702,6 @@ $ curl -k -u admin:admin https://<pikvm-ip>/api/redfish/v1/Systems
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### Individual system information
|
||||
|
||||
**Method**: `GET`
|
||||
|
|
@ -2074,13 +1723,6 @@ $ curl -k -u admin:admin https://<pikvm-ip>/api/redfish/v1/Systems/0
|
|||
FIXME
|
||||
```
|
||||
|
||||
**Responses**:
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 200 | FIXME |
|
||||
| 400 | FIXME |
|
||||
| 500 | FIXME |
|
||||
|
||||
### System configuration update
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue