Description
Updates a step on a project. Pass only the fields to change. propertiesJson is a JSON-encoded string matching the step template's property schema.
Filters (machineIdFilter, machineTagFilter, cloudTargetTagFilter) constrain which targets the step runs on within the step's selected environments.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
projectStepId |
body | string | yes | ID of the step. |
name |
body | string | no | New step name. |
description |
body | string | no | New description. |
stepTemplateId |
body | string | no | Switch to a different step template. |
runOn |
body | string | no | DeploymentTargets, Worker, CentralServer, etc. |
errorAction |
body | string | no | Stop, Continue, or ContinueOnError. |
disabled |
body | boolean | no | Disable the step without removing it. |
executeCondition |
body | string | no | When the step should run. |
executeConditionScript |
body | string | no | Script body when condition is Script. |
parallelMachines |
body | number | no | Max machines to run on in parallel. |
parallelCloudTargets |
body | number | no | Max cloud targets to run on in parallel. |
workerTagId |
body | string | no | Tag identifying the worker pool. |
environments |
body | array<string> | no | Environment IDs the step is restricted to. |
machineIdFilter |
body | array<string> | no | Restrict to these machine IDs. |
machineTagFilter |
body | array<object> | no | Tag-set filter for machines. |
cloudTargetTagFilter |
body | array<object> | no | Tag-set filter for cloud targets. |
propertiesJson |
body | string | no | JSON-encoded step property values. |
Errors
| Status | Meaning |
|---|---|
400 |
Invalid projectStepId or validation failure. |
401 |
Missing or invalid Basic auth credentials, or the service account lacks the required role. |