hosting_createNodeJSBuildFromArchiveV1
Upload a project archive to automatically detect build settings and start a Node.js build in one step.
Instructions
Upload a project archive, auto-detect build settings, and immediately start a Node.js build.
This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website's file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB.
Before archiving, exclude node_modules/ and any build output directories
(e.g. dist/, .next/, build/) — they are not needed because the build
process runs the install step automatically, and including them unnecessarily
increases the archive size. This also helps keep the archive well under the 50MB limit.
Example (zip):
zip -r archive.zip . --exclude "node_modules/*" --exclude "dist/*"The returned build uuid can be used to poll progress and retrieve logs via
the Get Node.js Build Logs endpoint.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | Yes | Domain name | |
| archive | Yes | Project archive file (.zip, .tar.gz, or .tgz), maximum 50MB | |
| app_type | No | Node.js application type override | |
| username | Yes | username parameter | |
| entry_file | No | Main entry point file override | |
| build_script | No | Build script override | |
| node_version | No | Node.js version override (auto-detected from package.json if omitted) | |
| root_directory | No | Application root directory override (where package.json is located) relative to public_html | |
| package_manager | No | Package manager override | |
| output_directory | No | Build output directory override relative to the root directory |