Skip to content

HTTP API

This is a brief introduction to the PiKVM API. Since the software consists of multiple microservices, Nginx provides a unified API entry point at /api/.

Authentication

All API endpoints require authentication. Each request must be authenticated individually, or you can obtain a token and pass it as a cookie with every request. When 2FA is enabled, you must append the one-time code to the password without spaces. You can use any TOTP library (for example, Python) to generate the code:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
import requests
import pyotp

user = "admin"
passwd = "admin"
secret = "3OBBOGSJRYRBZH35PGXURM4CMWTH3WSU"  # Can be found in /etc/kvmd/totp.secret

print(requests.get(
    url="https://pikvm/api/info",
    verify=False,  # For self-signed SSL certificate
    headers={
        "X-KVMD-User": user,
        "X-KVMD-Passwd": passwd + pyotp.TOTP(secret).now(),
    },
).text)

When the 2FA code is close to expiring, due to request latency the code may become invalid. A simple workaround for resulting 403 errors is to retry the request in seconds. A better approach is to combine this with checking the remaining validity; if about one second remains, delay the request. With this method, you can determine the remaining validity time:

1
2
3
totp = pyotp.TOTP(secret)
now = int(time.time())
remaining = now - (now % totp.interval)

Single-request authorization

  • Using X-headers, send: X-KVMD-User and X-KVMD-Passwd
1
curl -k -H X-KVMD-User:admin -H X-KVMD-Passwd:admin https://<pikvm-ip>/api/auth/check
  • Using HTTP Basic Auth. Contrary to the standard, this implementation does not use headers. HTTP Basic Auth here is only for compatibility with other systems.
1
curl -k -u admin:admin https://<pikvm-ip>/api/auth/check
  1. Obtain a cookie: POST /api/auth/login
1
2
3
4
$ curl -k -v -X POST --data user=admin --data passwd=admin https://pikvm/api/auth/login
...
< Set-Cookie: auth_token=796cb83b11de4fcb749bc1bad14a91fb06dede84672b2f847fef1e988e6900de; Path=/
...

Success returns HTTP 200; failure returns HTTP 403.

  1. GET /api/auth/check verifies the cookie status. Likewise, success returns 200 and failure 403.

  2. POST /api/auth/logout destroys the cookie.

System

Get software information GET /api/info returns all information about the PiKVM device.

Parameters: fields=... (optional) — return only specified categories, for example fields=system,hw. By default, all categories are shown.

1
curl -k -u admin:admin https://<pikvm-ip>/api/info
Click to expand 
  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
{
    "ok": true,
    "result": {
        "auth": {
            "enabled": true
        },
        "extras": {
            "ipmi": {
                "daemon": "kvmd-ipmi",
                "description": "Show IPMI information",
                "enabled": true,
                "icon": "share/svg/ipmi.svg",
                "name": "IPMI",
                "path": "ipmi",
                "place": 21,
                "port": 623,
                "started": true
            },
            "janus": {
                "daemon": "kvmd-janus",
                "description": "Janus WebRTC Gateway",
                "enabled": false,
                "name": "Janus",
                "path": "janus",
                "place": -1,
                "started": false
            },
            "janus_static": {
                "daemon": "kvmd-janus-static",
                "description": "Janus WebRTC Gateway (Static Config)",
                "enabled": true,
                "name": "Janus Static",
                "path": "janus",
                "place": -1,
                "started": true
            },
            "vnc": {
                "daemon": "kvmd-vnc",
                "description": "Show VNC information",
                "enabled": true,
                "icon": "share/svg/vnc.svg",
                "name": "VNC",
                "path": "vnc",
                "place": 20,
                "port": 5900,
                "started": true
            },
            "webterm": {
                "daemon": "kvmd-webterm",
                "description": "Open terminal in a web browser",
                "enabled": true,
                "icon": "extras/webterm/terminal.svg",
                "name": "Terminal",
                "path": "extras/webterm/ttyd",
                "place": 10,
                "started": true
            }
        },
        "fan": {
            "monitored": false,
            "state": null
        },
        "hw": {
            "health": {
                "temp": {
                    "cpu": 57.187
                },
                "throttling": {
                    "ignore_past": false,
                    "parsed_flags": {
                        "freq_capped": {
                            "now": false,
                            "past": false
                        },
                        "throttled": {
                            "now": false,
                            "past": false
                        },
                        "undervoltage": {
                            "now": false,
                            "past": false
                        }
                    },
                    "raw_flags": 0
                }
            },
            "platform": {
                "base": "Xunlei OneCloud",
                "serial": null,
                "type": "rpi"
            }
        },
        "meta": {
            "kvm": {},
            "server": {
                "host": "onecloud"
            }
        },
        "system": {
            "kernel": {
                "machine": "armv7l",
                "release": "6.6.34-current-meson",
                "system": "Linux",
                "version": "#10 SMP Sun Jun 16 19:47:49 CST 2024"
            },
            "kvmd": {
                "version": "3.291"
            },
            "streamer": {
                "app": "ustreamer",
                "features": {
                    "HAS_PDEATHSIG": true,
                    "WITH_GPIO": true,
                    "WITH_PTHREAD_NP": true,
                    "WITH_SETPROCTITLE": true,
                    "WITH_SYSTEMD": true
                },
                "version": "6.12"
            }
        }
    }
}

Get software logs GET /api/log returns logs for all KVMD services in plain text.

Parameters: follow=1 (optional) — long polling mode to tail logs in real time; seek=N (optional) — show logs for the last N seconds (for example, the last hour).

1
curl -k -u admin:admin https://<pikvm-ip>/api/log?seek=3600
Click to expand 
1
2
3
4
5
6
7
8
9
[2024-07-01 04:48:37 kvmd.service] --- aiohttp.access                    INFO --- [admin (token) / 192.168.31.242] 'GET /log?seek=120 HTTP/1.0' => 200; size=751 --- referer='-'; user_agent='Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0'
[2024-07-01 04:48:46 kvmd.service] --- aiohttp.access                    INFO --- [admin (token) / 192.168.31.242] 'GET /log?seek=1800 HTTP/1.0' => 200; size=2668 --- referer='-'; user_agent='Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0'
[2024-07-01 04:48:56 kvmd.service] --- aiohttp.access                    INFO --- [admin (token) / 192.168.31.242] 'GET /log?seek=3600 HTTP/1.0' => 200; size=2988 --- referer='-'; user_agent='Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0'
[2024-07-01 04:49:09 kvmd.service] --- aiohttp.access                    INFO --- [admin (token) / 192.168.31.242] 'GET /log?seek=7200 HTTP/1.0' => 200; size=3308 --- referer='-'; user_agent='Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0'
[2024-07-01 04:49:17 kvmd.service] --- aiohttp.access                    INFO --- [admin (token) / -] 'GET /auth/check HTTP/1.0' => 200; size=194 --- referer='-'; user_agent='Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0'
[2024-07-01 04:49:30 kvmd.service] --- aiohttp.access                    INFO --- [admin (token) / -] 'GET /auth/check HTTP/1.0' => 200; size=194 --- referer='-'; user_agent='Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0'
[2024-07-01 04:49:31 kvmd.service] --- aiohttp.access                    INFO --- [admin (token) / 192.168.31.242] 'GET /info?fields=auth,meta,extras HTTP/1.0' => 200; size=2141 --- referer='https://192.168.31.182/'; user_agent='Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0'
[2024-07-01 04:49:32 kvmd.service] --- aiohttp.access                    INFO --- [admin (token) / -] 'GET /auth/check HTTP/1.0' => 200; size=194 --- referer='https://192.168.31.182/'; user_agent='Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0'
[2024-07-01 04:49:33 kvmd-webterm.service] --- [2024/07/01 04:49:33:0792] N: WS   /ws - , clients: 1