Schedule now transform APIedit

Instantly runs a transform to process data.


POST _transform/<transform_id>/_schedule_now


  • Requires the manage_transform cluster privilege. This privilege is included in the transform_admin built-in role.


When you run this API, processing for the next checkpoint is started immediately without waiting for the configured frequency interval. The API returns immediately, data processing happens in the background. Subsequently, the transform will be processed again at now + frequency unless the API is called again in the meantime.

Path parametersedit

(Required, string) Identifier for the transform.

Query parametersedit

(Optional, time) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.


response = client.transform.schedule_now_transform(
  transform_id: 'ecommerce_transform'
puts response
POST _transform/ecommerce_transform/_schedule_now

When the transform is scheduled now, you receive the following results:

  "acknowledged" : true