Pipeline step mode
Use step mode when you want to review what would run next and decide when to advance a rollout. Each step uses the pipeline's normal scheduling rules and may start multiple eligible target runs. The pipeline advances only when an operator requests a scheduling step.
Enter step mode
Send PATCH /spaces/{spaceId}/pipelines/{pipelineName} with Content-Type: application/json and this body.
{
"execution": {
"runMode": "step"
}
}Set execution.runMode to auto to return to automatic execution. See Pipelines for the full PATCH endpoint.
/spaces/{spaceId}/pipelines/{pipelineName}/previewGETShow which targets and releases the scheduler would select right now, without scheduling any work.
Sample request
GET /spaces/space_123/pipelines/web/preview HTTP/1.1 Host: api.munchii.com Authorization: Bearer <access-token>Example response
HTTP/1.1 200 OK Content-Type: application/json { "data": { "start": [ { "name": "deploy", "release": 42 } ] } }Common errors
401The credentials are missing, expired, or invalid.403The caller lacks permission for this operation.404The space or pipeline was not found.409The pipeline must be in step mode.
/spaces/{spaceId}/pipelines/{pipelineName}/stepPOSTRun one scheduling step, starting the target runs selected by the scheduler.
Sample request
POST /spaces/space_123/pipelines/web/step HTTP/1.1 Host: api.munchii.com Authorization: Bearer <access-token>Example response
HTTP/1.1 200 OK Content-Type: application/json { "data": { "started": [ { "id": "target_123", "release": 42 } ] } }Common errors
401The credentials are missing, expired, or invalid.403The caller lacks permission for this operation.404The space or pipeline was not found.409The pipeline must be in step mode.