API reference

VMBook HTTPS API v1

Build scripts and tools against the controlled backend used by the desktop window.

Contract

The /v1 contract grows additively: fields and paths may be added, but documented v1 behavior is not changed or removed. The host composes commands from stored settings; callers cannot submit shell commands.

Base URL

https://{host}:3333/v1

TLS 1.3 is required. /v1/host and /v1/openapi.yaml are public; other calls need a bearer token.

First request

curl -s -k --pinnedpubkey 'sha256//FINGERPRINT' \
  -H 'Authorization: Bearer TOKEN' \
  https://host.example:3333/v1/machines
Do not omit the pin

-k permits the computer’s self-issued certificate; --pinnedpubkey still rejects a substituted key.

Resources

OpenAPI

Every release serves its OpenAPI 3 description at /v1/openapi.yaml. Use that copy when generating a client for the installed release.