Skip to content
Factflow

Update Pipeline State

PATCH
/api/v1/pipelines/{route_id}

Pause/resume a route globally (affects ALL executions with this route).

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
route_id
required
Route Id
string

Request Body required

Section titled “Request Body required ”
PipelineStateUpdateRequest

Request to update pipeline state.

Used with PATCH /pipelines/{route_id} to change pipeline state.

object
state
required
State

Target state: ‘paused’ or ‘running’

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

PipelineControlResponse

Pipeline control operation response.

object
success
required
Success

Whether operation succeeded

boolean
route_id
required
Route Id

Route ID

string
message
required
Message

Operation status message

string
status
required
Status

Pipeline status after operation

string

404

Section titled “404 ”

Resource not found

ErrorResponse

Standard error response matching FastAPI HTTPException format.

This model is used in OpenAPI response declarations for 4xx/5xx errors. The detail field matches FastAPI’s HTTPException structure.

object
detail
required
Detail

Error message (matches FastAPI HTTPException)

string
error_code
Any of:
string
correlation_id
Any of:
string
timestamp
Timestamp

Error timestamp

string format: date-time

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object