Schedule a transform to start now

Auth

Instantly run a transform to process data. If you run this API, the transform will process the new data instantly, without waiting for the configured frequency interval. After the API is called, the transform will be processed again at now + frequency unless the API is called again in the meantime.

Required privileges

Cluster privileges manage_transform

Path parameters

transform_id string required

Identifier for the transform.

Query parameters

timeout string · default: 30s

Controls the time to wait for the scheduling to take place

defer boolean · default: false

When true, defers the scheduling by the transform's configured sync delay instead of triggering immediately. The transform will process new data after the delay elapses rather than right away.

Response

application/json
acknowledged boolean required

For a successful response, this value is always true. On failure, an exception is returned instead.