hosting_startNode_jsBuildV1
Start a Node.js build from an archive already on the server, using stored files to compile and deploy the app. Note: this overwrites existing website content.
Instructions
Start a Node.js build process using files already present on the website's file storage.
WARNING: on success this overwrites the website's existing contents and cannot be undone — verify this is intended before calling this endpoint.
The source_type must be archive and source_options.archive_path must point to an
existing archive file on the server (relative to the website document root).
Use the Generate Upload URL endpoint to obtain credentials and upload the archive first.
To auto-detect build settings from an archive before starting, first call the
Get Node.js Build Settings from Archive endpoint.
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 | |
| app_type | Yes | Node.js application type | |
| username | Yes | username parameter | |
| entry_file | No | The main entry point file for the application | |
| source_type | Yes | The source type of the files | |
| build_script | Yes | Build script that will be ran to build the application | |
| node_version | Yes | Node.js version | |
| root_directory | Yes | Application root directory (where package.json is located) relative to public_html | |
| source_options | Yes | Source-specific options | |
| package_manager | No | Package manager | |
| output_directory | Yes | Build output directory relative to the root directory |