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

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Response

application/json

Examples

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

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

{
  "acknowledged": true
}