Run an on demand automation

post

https://api.qfp.quantnetwork.net/api/automations/{automationId}/executions

Requests a run of one ON_DEMAND automation, and returns 202 with the execution id.

The Idempotency-Key determines that execution id, so retrying with the same key replays the first 202 with Idempotency-Replayed: true rather than starting a second run.

The automation must be ACTIVE and ON_DEMAND, and can be run by anyone in the organisation.

parameterOverrides apply to that run only and are never written back to the automation. Each is matched to the script's declared params by key, case-insensitively; a key not overridden keeps its configured value. The body is optional — omit it to run with the configured values.

Path Params

automationId

uuid

required

Id of the automation.

Body Params

Optional body for an on demand run. Omitting the body entirely is equivalent to sending {} — the automation runs with the parameter values it was configured with.

parameterOverrides

array of objects

Values that replace the automation's configured script parameters for this run only. Matched to the script's declared params by key, case-insensitively; a key that is not listed keeps its configured value. Overrides are scalar {key, value, type} entries.

parameterOverrides

Headers

API-Version

string

^\d+\.\d+\.\d+$

Version of the API contract the client targets, in MAJOR.MINOR.PATCH format. Mandated by the Gateway standard. Not yet enforced: requests without the header, or with an unsupported value, are currently processed normally. Once enforcement is enabled, such requests will be rejected with 400 Bad Request.

Idempotency-Key

string

required

length ≥ 1

Required on every POST, PUT and PATCH. A client-generated key: retrying with the same key returns the original response without running the request again. Scoped per tenant, user, method and path. A missing or blank key is rejected with 400.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202The run was requested. parameters are the values it was started with — the automation's configured values, with any overrides applied.

400The Idempotency-Key header is missing or blank, an override's key is blank or its value/type is missing, or automationId is not a UUID.

404No automation with this id exists, or it has been deleted.

409The automation exists but cannot be run on demand — it is not ACTIVE, or its triggerType is not ON_DEMAND — or a request with the same Idempotency-Key (for this tenant + user, method and path) is already in flight.

422An override does not fit the script's declared parameters — an unknown key, a type that contradicts the declaration, or a value that cannot be parsed as that type.

500The automation matched but the run could not be requested. No partial run is recorded, and the idempotency claim is released, so the same key can be retried.