NEnexla
Flows

Pause a Flow

To pause the entire flow, use either the origin_node_id from any data source, set or sink in the flow, or include the ?all=1 or ?full_tree=1 query parameter.

Note:

  1. All endpoints for activating or pausing a flow operate on the specific resource given and all of the flow nodes downstream from that resource. This allows for pausing and activating sub-flows while leaving the rest of the flow state unchanged.

  2. You can also pause a flow by using the id of the data_source/ data_set / data_sink that the flow node is linked to. See relevant endpoints in the API references for those resources.

put/flows/{flow_id}/pause

Request

Path parameters

flow_idinteger required

The unique ID of the flow that needs to be paused.

all1 required

Set this query parameter if the flow node ID you are making a call with is not an origin flow node but you want to pause the full flow chain. Not necessary if the flow node is an origin flow node.

Query parameters

asyncboolean

If set to 'true', request will be executed in a deferred way, and results will be provided later. Notice: only works with all=1 or full_tree=1.

request_idinteger

The unique ID of the asynchronous request. In case it's provided, returns info about the deferred request.

Headers

Accept'application/vnd.nexla.api.v1+json' | 'application/json'

Setting to application/vnd.nexla.api.v1+json is recommended.

Response

OK

OR

Changes

No recorded changes to this operation across all 1 revision of this API.