Sign in

v4

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-05-09283767.7 KB
vm-services

List service registrations

Returns the services currently registered on this VM, sorted by name. Each service is exposed at https://<name>--<vmIdHexNoHyphens>.proxy.<stack-domain> over HTTPS.

get/v1/vms/{id}/services

Response

Services

namestring required

Service name (1–29 chars). Embedded in the public URL as <name>--<vmIdHexNoHyphens>.proxy.<stack-domain>.

portinteger required

TCP port the service listens on inside the VM. Privileged ports (<1024) are rejected.

h2cboolean required

When true, the proxy speaks HTTP/2 cleartext (h2c) to the backend. Required for gRPC and h2c-only apps. When false (default), the proxy uses HTTP/1.1 — covers HTTP/1.1 apps, Server-Sent Events, and WebSocket pass-through.