workflow management

Update Workflow Run

Update status, metadata, or output on a workflow run.

patch/v1/workflows/runs/{run_id}

Path parameters

run_idstring required

Request body

status'pending' | 'running' | 'paused' | 'completed' | 'failed' nullable
outputobject nullable
metadataobject nullable

Response

Successful Response

{"stackTrail":"paths:/v1/workflows/runs/{run_id}:patch:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 1 of the 42 revisions of this API.2

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog