Validate a project config
POST
Checks a .homemade/config.json or .jsonc file against the config schema. .ts and .js configs are checked at the first build instead.
apiKeyheader
AuthorizationBearer <hmk_…>An API key from the dashboard or homemade api-key create.
application/json- body
content*stringLength
length <= 262144path*stringValue in
".homemade/config.ts"".homemade/config.js"".homemade/config.jsonc"".homemade/config.json"The verdict; error says what is wrong.
application/json- response
error?stringWhy the file is invalid (present when ok is false).
ok*booleanpath*stringValue in
".homemade/config.ts"".homemade/config.js"".homemade/config.jsonc"".homemade/config.json"curl -X POST 'https://api.homemade.dev/api/config/validate' \ -H 'Content-Type: application/json' \ -d '{ "content": "string", "path": ".homemade/config.ts"}'Example Response
{ "error": "string", "ok": true, "path": ".homemade/config.ts"}Update project settings PATCH
Changes the project's slug, default branch, default auto-sleep and other settings. Every field is optional.
Create a VM POST
Creates a VM from a project's latest build and starts it. The answer comes at once with the VM in `queued` or `booting`; poll `GET /api/vms/{vmId}` until `state` is `running`.