Apps

List Apps

GET

Returns all apps in your workspace. Pass ?workspaceId= to target a specific workspace when using an API key.

Field	Type	Description
`workspaceId`	`string`	Target workspace (optional)
`organizationId`	`string`	Target org (optional)

Response

{
  "success": true,
  "apps": [
    {
      "id": "app_001",
      "name": "my-api",
      "runtime": "node",
      "status": "running",
      "memoryMB": 512,
      "exposePort": 3000,
      "subdomain": "my-api"
    }
  ],
  "meta": { "total": 1 }
}

Get App

GET /api/apps/:appId

Deploy from ZIP

POST /api/apps/deploy

Upload a ZIP file and deploy a new application.

Request body (multipart/form-data)

Field	Type	Required	Description
`file`	`File`	Yes	ZIP containing your app
`name`	`string`	Yes	App name
`runtime`	`string`	Yes	`node` \| `bun` \| `python`
`memoryMB`	`number`	Yes	Memory allocation (MB)
`startupCommand`	`string`	No	Start command. Omit or `"auto"` to let Hyze detect (Vite, Next, Node, static, Python…).
`envVars`	`string (JSON)`	No	Environment variables
`exposePort`	`number`	No	Port to expose
`subdomain`	`string`	No	Custom subdomain
`autoRestart`	`boolean`	No	Auto-restart on crash
`machineId`	`string`	No	Target specific machine

Language=bash

curl -X POST https://api.hyzecloud.com/api/apps/deploy \
  -H "Authorization: Bearer hyze_your_key" \
  -F "file=@app.zip" \
  -F "name=my-api" \
  -F "runtime=node" \
  -F "memoryMB=512" \
  -F "exposePort=3000"
# optional: -F "startupCommand=node server.js"  (omit or use auto for detection)

Deploy from GitHub Repo

POST /api/apps/deploy-from-repo

Deploy from a connected GitHub repository.

Request body

Field	Type	Required	Description
`name`	`string`	Yes	App name
`runtime`	`string`	Yes	`node` \| `bun` \| `python`
`memoryMB`	`number`	Yes	Memory (MB)
`startupCommand`	`string`	No	Start command. Omit or `"auto"` to let Hyze detect (Vite, Next, Node, static, Python…).
`envVars`	`string (JSON)`	No	Environment variables
`exposePort`	`number`	No	Port to expose
`subdomain`	`string`	No	Custom subdomain
`autoDeploy`	`boolean`	No	Auto-deploy on push
`machineId`	`string`	No	Target machine
`repository`	`object`	Yes	`{ id, owner, name, branch, path?, githubInstallationId? }`

Inspect Env

POST /api/apps/inspect-env

Upload a ZIP and detect required environment variables without deploying.

Field	Type	Required	Description
`file`	`File`	Yes	ZIP file

Start App

POST /api/apps/:appId/start

Stop App

POST /api/apps/:appId/stop

Restart App

POST /api/apps/:appId/restart

Delete App

DELETE /api/apps/:appId

Get Logs

GET /api/apps/:appId/logs

Field	Type	Default	Description
`tail`	`number`	`100`	Number of lines
`timestamps`	`boolean`	`false`	Include timestamps

Get Environment Variables

GET /api/apps/:appId/env

Returns decrypted environment variables.

Response

{
  "success": true,
  "envVars": { "DATABASE_URL": "...", "PORT": "3000" }
}

Set Environment Variables

PUT /api/apps/:appId/env

Merges new variables into existing ones.

Field	Type	Required	Description
`envVars`	`Record<string, string>`	Yes	Key-value pairs

Language=bash

curl -X PUT https://api.hyzecloud.com/api/apps/app_001/env \
  -H "Authorization: Bearer hyze_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "envVars": { "NODE_ENV": "production" } }'

Update Settings

PUT /api/apps/:appId/settings

Updates app settings. When runtime-affecting fields change, the container is restarted.

Field	Type	Description
`name`	`string`	New name
`runtime`	`string`	`node` \| `bun` \| `python`
`memoryMB`	`number`	Memory (MB)
`startupCommand`	`string`	Start command (`"auto"` or custom). Optional on create.
`exposePort`	`number \| null`	Port to expose
`subdomain`	`string \| null`	Custom subdomain
`autoRestart`	`boolean`	Auto-restart on crash

Get Build History

GET /api/apps/:appId/builds

Returns recent deploy build entries.

Visão geral

Endpoints

List Apps

Get App

Deploy from ZIP

Deploy from GitHub Repo

Inspect Env

Start App

Stop App

Restart App

Delete App

Get Logs

Get Environment Variables

Set Environment Variables

Update Settings

Get Build History

​List Apps

​Get App

​Deploy from ZIP

​Deploy from GitHub Repo

​Inspect Env

​Start App

​Stop App

​Restart App

​Delete App

​Get Logs

​Get Environment Variables

​Set Environment Variables

​Update Settings

​Get Build History

List Apps

Get App

Deploy from ZIP

Deploy from GitHub Repo

Inspect Env

Start App

Stop App

Restart App

Delete App

Get Logs

Get Environment Variables

Set Environment Variables

Update Settings

Get Build History