HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Update a live deployment's schedule in place

Change a live deployment's schedule in place: interval, delay, properties, twins, version, or re-pin imageId. The record keeps its id, release and sha — only the schedule is rewritten. Read-only fields (status, steps, sha, release, ...) may be present with their current values, so a GET body can be PUT back unchanged, but changing one is a 400. Edge targets are supported: send twins as {twin, target, deviceId} to move one between cloud and edge, and the side it left is cleaned up. Refused while pending or deploying.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The UUID of the deployment

Body Params
integer

schedule interval in ms

integer

delay in ms

properties
object

pipeline variables passed to each execution

boolean

produce the pipeline's PLOT steps on each triggered run (default false). Needs every twin on the cloud target — an edge device has nowhere to publish a plot.

boolean

retrain the pipeline's models on each triggered run (default false). Needs every twin on the cloud target AND packaging 'release': a model frozen in an image cannot be replaced, so a retrained one would be silently discarded.

boolean

run the pipeline's WRITE steps (default TRUE — this is what a scheduled pipeline is normally for).

twins
object

hardware ids this schedule covers, or {twin, target, deviceId} entries where target is "cloud" (default) or "edge" — the same shape the deploy request takes. Retargeting a twin moves it and removes it from the side it left.

string

python version / runtime variant

string

re-pin to an image that already exists. A fresh BUILD is not an update — that outlasts the gateway timeout and is a redeploy.

Response

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json