Skip to main content
Use the Apps API when you want deploys from CI/CD, internal tools, or your own control panel. Two paths: upload a ready ZIP or point to a connected GitHub repository.

Choose a deploy source

Deploy from a ZIP

1

Package your app

Create a ZIP with the files Hyze should run: your app’s entrypoint and dependency manifest.
2

Send the deploy request

startupCommand is optional. Omit it (or use auto) and Hyze detects the right command. Override only if needed: -F "startupCommand=node server.js".
3

Verify the result

Poll GET /api/apps/:appId until status: running, then open the logs:

Deploy from GitHub

Use POST /api/apps/deploy-from-repo after connecting GitHub in the dashboard:
With autoDeploy: true, pushes to the branch trigger new deploys automatically.

Runtimes

Optional override examples: node server.js, bun run start, python main.py.
With an exposed port, pass the full host as the subdomain (e.g. my-api.hyzecloud.app), not just the prefix.

Common problems

Check exposePort and that your server listens on 0.0.0.0. Read the logs to rule out a boot crash.
Pass startupCommand to override (e.g. node server.js) or leave it out for default detection.

Next steps

Apps reference

Deploy, lifecycle, logs, settings, and builds.

App backups

Create, restore, download, and delete app backups.
Last modified on September 1, 2026