deployments

Preview Deploy

Preview the auto-derived schedule and universe hygiene for a strategy.

post/v1/deployments/preview

Request

  • Base URL: https://api.usekeel.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.usekeel.io/v1/deployments/preview
  • Auth: none declared

Headers

Authorizationstring nullable
X-Org-Idstring nullable

Request body

strategy_idstring required
tranchingobject nullable

Optional tranche schedule block to preview — the same raw shape DeployLiveRequest accepts. A valid block populates the tranche_* response fields (and derived_schedule becomes the tranche cron the deploy would write); an invalid block is a 422 with the exact parse/derive reason, so the wizard can show it inline.

deployment_idstring nullable

Optional deployment to preview an UPDATE for (the Update-Live dialog). Must belong to the caller's org (404 otherwise) and reference strategy_id (422 otherwise). Its carried tranching block joins the schedule derivation exactly as update_live's re-derivation would use it, so a tranched deployment's update preview shows the tranche cron rather than a spurious anchor-cron schedule change. Block precedence: an explicit tranching in this request > the deployment's carried block > none.

Response

Successful Response

strategy_namestring required
timeframestring nullable
bar_offsetstring nullable
derived_schedulestring nullable
schedule_descriptionstring nullable
universe_sizeinteger nullable
tranching_availableboolean required
maker_availableboolean required
tranche_event_timesstring[] nullable
tranche_schedule_descriptionstring nullable
tranching_blockobject nullable
execution_style_blockobject nullable

Changes

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