Platform

startEnvironmentDeploy

Deploy scope. Deploy every non-preview service of the environment in role order (database, cache, worker, web): each stage is an ordinary smart-replace deploy whose start is gated on the previous stage reporting a HEALTHY start (require_healthy_start, default true — every stage's agent must already announce startup-health-v1, pre-checked before anything queues; pass false to deploy without the gate). Variable groups resolve and the environment's database wiring applies per stage. One running batch per environment and every component must be settled. A failed stage fails the batch; the stages that already succeeded stay deployed.

post/platform/environments/{id}/deploy

Request

  • Base URL: https://api.imprezahost.com/v1
  • URL: https://api.imprezahost.com/v1/platform/environments/{id}/deploy
  • Auth: API key in header X-API-Key and API key in header X-API-Secret

Path parameters

idstring required

Request body

require_healthy_startboolean

Response

Batch accepted: batch_id (edb_...), ordered stages and cursor

Changes

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