v0.1.7

API Reference

Last updated


This page lists every QemuRun-pve REST endpoint at a glance; each group has its own detail page.

Conventions


ItemDescription
Base URLhttp://<main node IP>:<PORT>/api
Request formatContent-Type: application/json
AuthenticationNo token; mutating endpoints match the client IP against ALLOW_IPS, see Access Control
Sync responsesPlain text ok on success; plain-text error with 4xx / 5xx on failure
SSE responsestext/event-stream, ending with event: close, see SSE Events
:idInteger VMID; unparsable values make sync endpoints return 500 (/status returns 400)

Endpoints


MethodPathResponseALLOW_IPSRequired VM stateDetails
GET/healthtext ok——Query Endpoints
GET/vm/listJSON——Query Endpoints
GET/vm/:id/statustext——Query Endpoints
POST/vm/installSSE✓—Install Endpoint
POST/vm/:id/startSSE✓stoppedLifecycle Endpoints
POST/vm/:id/rebootSSE✓runningLifecycle Endpoints
POST/vm/:id/shutdowntext ok✓runningLifecycle Endpoints
POST/vm/:id/stoptext ok✓runningLifecycle Endpoints
POST/vm/:id/destroytext ok✓stoppedLifecycle Endpoints
POST/vm/:id/set/cputext ok✓stoppedResource Endpoints
POST/vm/:id/set/memorytext ok✓stoppedResource Endpoints
POST/vm/:id/set/disktext ok✓stoppedResource Endpoints
POST/vm/:id/set/nodeSSE✓stoppedResource Endpoints

Static Files


GET /sh/<file> serves the sh/ directory so new VMs can download their OS Init Scripts; this path is outside /api and does not check ALLOW_IPS.
中文