Run Orchestration

Running an Orchestration or Flow is in principle same as running a job. You can create (run) an orchestration job from the UI. A job can also be created manually via the API. The easiest way to get started is to create a configuration of orchestration or flow and run it manually in the UI. Once you’re satisfied with the result, look at the successful job:

Screenshot -- Orchestration Parameters

In the job detail, you can see the parameters required to run the configuration, in this case:

mode: run
component: keboola.orchestrator
config: 1496488

The difference between running an arbitrary component job and an orchestrator job is only in that the component value is always keboola.orchestrator. The same component is used for both Orchestrator and Flow jobs.

Create a Storage API token which you will use to run the API requests (if you don’t have one already). We recommend to create a token with Full Access to components. Though you can list the components used in the orchestration, this leads to a fragile setup when modifying the orchestration may need the modification of the the token too.

Then use the Create Job API call to create a job with the same parameters (see example):

curl --location --request POST '' \
--header 'X-StorageApi-Token: YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mode": "run",
    "component": "keboola.orchestrator",
    "config": "1496488"

Take care to use the right endpoint depending on which Stack are you using. You’ll see Invalid access token error message if you are using the wrong endpoint or token. Read more about the concept of Jobs.