Schedule a transform to start now

POST /_transform/{transform_id}/_schedule_now

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 authorization

Cluster privileges: manage_transform

Path Parameters

transform_id string Id required: Identifier for the transform.

Query Parameters

timeout string Duration · default: 30s: Controls the time to wait for the scheduling to take place

Response

application/json

Examples

A successful response when the transform is scheduled to run now.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _transform/ecommerce_transform/_schedule_now

JavaScript Elasticsearch JavaScript Client

const response = await client.transform.scheduleNowTransform({
  transform_id: "ecommerce_transform",
});

Python Elasticsearch Python Client

resp = client.transform.schedule_now_transform(
    transform_id="ecommerce_transform",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_transform/ecommerce_transform/_schedule_now" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.transform().scheduleNowTransform(s -> s
    .transformId("ecommerce_transform")
);

C# Elasticsearch .NET Client

var response = await client.TransformManagement.ScheduleNowTransformAsync(transformId: "ecommerce_transform");

PHP Elasticsearch PHP Client

$resp = $client->transform()->scheduleNowTransform([
    "transform_id" => "ecommerce_transform",
]);

Ruby Elasticsearch Ruby Client

response = client.transform.schedule_now_transform(
  transform_id: "ecommerce_transform"
)

Response

{
  "acknowledged": true
}