Platform

Save final project deployment configuration for review

Deploy scope. Freezes effective configuration and generated recipe; encrypts environment values and returns names only. Review configuration_digest before applying. No resource reservation; expires no later than source plan / 24 hours. At most 20 pending records.

post/platform/deployments/custom/plans/{plan_id}/prepare-deployment

Request

  • Base URL: https://api.imprezahost.com/v1
  • URL: https://api.imprezahost.com/v1/platform/deployments/custom/plans/{plan_id}/prepare-deployment
  • Auth: API key in header X-API-Key and API key in header X-API-Secret

Path parameters

plan_idstring required

Request body

option_indexinteger required
build_secretsobject

Build-only credentials for Dockerfile or npm recipes; encrypted in the prepared configuration, with names only in summaries. Requires agent 0.6.11+ advertising build-secrets-v1. Total UTF-8 values are limited to 256 KiB. Secret builds bypass cached layers.

namestring required

Per-account-unique deploy name (3-100 chars, [a-z0-9_-]).

agent_idstring required

Target VPS agent_id (from impreza_list_servers).

domainstring

Hostname to use, or omit to propose a managed subdomain. No DNS record is created until apply. Omit with onion=true for onion-only.

varsobject

Runtime environment values, encrypted in the prepared record. Do not use reserved system/routing names. Summaries show names only.

cpusnumber

CPU limit; effective default is captured for review.

memory_mbinteger

Memory limit in MiB; effective default is captured for review.

target_portinteger

Optional container port; defaults to the selected recipe.

volumesstring[]

Absolute container paths to persist as named Docker volumes (data survives redeploys), e.g. ["/var/lib/app/data","/app/uploads"]. Ignored for mode=manifest (declare volumes in your compose).

onionboolean

Also publish a Tor v3 hidden service. Default false.

healthcheck_pathstring

node_npm, python_pip or php_composer only. Optional HTTP path such as /health (200 ASCII characters max). Checks 127.0.0.1 on target_port and requires 2xx without redirects. Omit for /: Python/PHP require 2xx; legacy Node accepts status below 500. Saved at creation; previews and redeploys retain it. A failed replacement recovers a verified healthy previous release; first installs keep the agent startup warning policy.

tor_egressboolean

Opt-in custom image/source runtime through Tor SOCKS5h. Requires agent 0.6.20+, local MCP 0.42.0+, tor-egress-v1 and Docker 28+. The application must use the Tor SOCKS5h proxy; existing servers require an explicit agent update. No direct fallback; builds/source retrieval are not anonymized. Imported manifests, catalog installs and external service bindings are unsupported.

require_healthy_startboolean

node_npm, python_pip or php_composer only. Require an explicit healthcheck_path to become healthy before deployment succeeds, including the first install. Requires agent 0.6.3+. Failed first installs remove containers and preserve volumes; eligible previous releases recover. Omit or false keeps legacy behavior. Saved at creation and inherited by previews/redeploys.

startup_timeout_secondsinteger

Required healthy start only: startup observation budget in seconds, default 60. Separate from source/build and recovery time.

Response

Prepared configuration saved without creating an app, job or DNS record.

Changes

No recorded changes to this operation across all 1 revision of this API.