REST: Update Workloads¶
These endpoints drive change events on a running Workload—promotion from draft to production and inspection of past replacements. Runtime updates that trigger a replacement (PATCH /workloads/{workload_id}/settings) are documented under REST: operate Workloads because they live on the same settings surface used for routine tuning.
Promote¶
Promote a draft Workload to production in place. See Promote to production for semantics and the preserved-identity guarantees.
| Verb | Path | Description |
|---|---|---|
POST |
/workloads/{workload_id}/promote |
Lock the draft artifact, assign a version, reset stats, and remove the draft TTL (time-to-live). |
Replacements¶
Trigger, inspect, and cancel artifact replacements on a Workload. See Replace and roll out for the lifecycle and rollout strategy.
| Verb | Path | Description |
|---|---|---|
POST |
/workloads/{workload_id}/replacement |
Start a replacement onto a new artifact. Body is a StartReplacementRequest (artifactId and strategy required; config and runtime optional). Returns 202 with a Replacement. |
GET |
/workloads/{workload_id}/replacement |
Get the current active Replacement for the Workload. |
DELETE |
/workloads/{workload_id}/replacement |
Cancel an active replacement. Returns 202. |
Replacement history¶
Inspect previous replacements on a Workload, including strategy, candidate artifact, and final outcome.
| Verb | Path | Description |
|---|---|---|
GET |
/workloads/{workload_id}/history |
List the replacement history for a Workload (ReplacementHistoryListResponse). |