deployments

Update Live

post/v1/deployments/{deployment_id}/update

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/{deployment_id}/update
  • Auth: none declared

Path parameters

deployment_idstring required

Headers

Authorizationstring nullable
X-Org-Idstring nullable

Request body

schedulestring nullable

Optional cron spelling; it must equal the selected commit's derived schedule. Omit to reconcile automatically. On a deployment whose tranching block is being changed in this same request, the derived schedule is the one implied by the NEW block.

intent_tokenstring nullable

Optional update-intent token when this update completes a handoff flow. Telemetry-only, mirroring DeployLiveRequest.intent_token: a valid token bound to this exact deployment makes the update emit handoff_completed (kind=update); it never gates or alters the update and carries no configuration.

tranchingobject nullable

Three-way (see class docstring): omit to carry the current block, send a block ({"mode": "equal_split", "count": N, "window"?: M} or {"mode": "custom", "times": ["HH:MM", ...], "window"?: M}) to change it, or send null to remove it and return the deployment to a single fire per period. Setting a block requires the org's 'tranching' execution grant (403 without it); an invalid block is a 422 with the exact reason.

execution_styleobject nullable

Three-way (see class docstring): omit to carry the current style, send the closed-world maker document to change it, or send null to disarm back to market. Setting a style requires the org's 'maker' execution grant (403 without it); an invalid document is a 422 with the exact parse reason.

Response

Successful Response

deployment_idstring required
strategy_idstring required
namestring required
statusstring required
schedulestring nullable
source_hashstring nullable
s3_keystring nullable
org_idstring nullable
account_idstring nullable
deployed_atstring nullable
stopped_atstring nullable
created_atstring nullable
updated_atstring nullable
deployed_commit_idstring nullable
deployed_version_stringstring nullable
config_idstring nullable
total_pnlnumber nullable
position_countinteger nullable
remainingobject nullable
execution_style'market' | 'maker' nullable
paused_reasonstring nullable
paused_atstring nullable
tranchingobject nullable
health'running' | 'degraded' | 'stalled' | 'stopped' nullable
serving_warningsobject[] nullable

Changes

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