Update existing Workloads¶
Preview
The Workload API is a preview feature, on by default.
Feature flag: Enable Access to Workload API Experimental Features
Update a Workload when what it runs needs to change—a new artifact version, a new runtime configuration, or a draft graduating to production. The platform handles the swap with no downtime: a candidate proton starts up alongside the active one, traffic shifts onto it, and the previous proton drains.
| Resource | Description |
|---|---|
| Replace and roll out | Replace rules, the rolling strategy, candidate protons, replacement status, and history. |
| Promote to production | POST /workloads/{id}/promote—lock the artifact, reset stats, remove the draft TTL (time-to-live), identity preserved. |
| Tutorial: Replace the artifact behind a running Workload | End-to-end rolling replacement walkthrough—swap the artifact backing a live Workload with no endpoint change. |
| REST: Update Workloads | Promote and replacement-history APIs. |
| UI: Update deployed Workloads | Console actions for replace and promote. |
For day-to-day operations (start, stop, settings, sharing), see Operate Workloads.