Skip to Content
homemade
Dashboard

Homemade API

Create VMs for your projects, run commands in them, put them to sleep and delete them, from any language that can send an HTTP request.

Base URL

Every path in these docs is relative to:

https://api.homemade.dev

Requests and answers are JSON. The API reference lists every operation, and you can send real requests from each page with your own key. The same description is published as an OpenAPI 3.1 document at https://api.homemade.dev/openapi.json for code generators and API clients.

VMs start in the background

Creating or waking a VM answers at once, while the VM is still starting. Poll GET /api/vms/{vmId} every few seconds until vm.state is running, then run commands in it. A VM that stopped for good ends in failed or stopped; stop polling then.

Next

  • The quickstart creates a VM, runs a command in it and deletes it, in about five minutes.
  • Authentication and errors covers API keys and what each error status means.
  • The CLI does the same from a terminal, and adds a shell, SSH and editor access.

On this page