Run

Runs a Flow and returns the response object defined by the Flow definition. The maximum allowed execution time is 300 seconds (5 minutes). If the Flow needs longer than 5 minutes to complete, use the Submit API instead.

[POST] api/v1/tenants/{tenantId}/workspaces/{workspaceId}/flows/{flowId}/run?env={env}&api_key={apikey}

View the execution endpoints of the Flow to find the exact address to use.

Parameters

This API can be called with a JSON or binary payload as the HTTP body. Use the HTTP Trigger do define how the input is deserialized in the Flow.

Parameter	Description
env	Development, Test or Production OR 0 (Development), 1 (Test), 2 (Production)
api_key	An API key with the Execute policy

Headers

Header	Description
x-api-key	An API key with the Execute policy

Note

When executing a Flow using this API, you must include the API key in either the query string OR the header, but not both.

Response

Body
The API may return a JSON object or a binary file (FileContentResult) depending on how the Flow is configured. If the Flow is not configured to return any data, the returned value is null.

Headers
flow-job-id: The id of the job. You can use this value to get the log for the run if you need to.