Skip to main content
POST
/
api
/
ledger
/
v2
/
{ledger}
/
pipelines
/
{pipelineID}
/
start
Start pipeline
curl --request POST \
  --url http://localhost/api/ledger/v2/{ledger}/pipelines/{pipelineID}/start
{
  "errorCode": "VALIDATION",
  "errorMessage": "[VALIDATION] invalid 'cursor' query param",
  "details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9"
}

Documentation Index

Fetch the complete documentation index at: https://docs.formance.com/llms.txt

Use this file to discover all available pages before exploring further.

Start or resume a stopped pipeline. The pipeline will begin streaming new events and catch up on any missed data.

Path Parameters

​
ledger
string
required

Name of the ledger.

Example:

"ledger001"

​
pipelineID
string
required

The pipeline id

Response

Pipeline started