Set upgrade_mode for transform indices

POST /_transform/set_upgrade_mode

Sets a cluster wide upgrade_mode setting that prepares transform indices for an upgrade. When upgrading your cluster, in some circumstances you must restart your nodes and reindex your transform indices. In those circumstances, there must be no transforms running. You can close the transforms, do the upgrade, then open all the transforms again. Alternatively, you can use this API to temporarily halt tasks associated with the transforms and prevent new transforms from opening. You can also use this API during upgrades that do not require you to reindex your transform indices, though stopping transforms is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get transform info API.

Required authorization

Cluster privileges: manage_transform

Query Parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _transform/set_upgrade_mode?enabled=true

JavaScript Elasticsearch JavaScript Client

const response = await client.transform.setUpgradeMode({
  enabled: "true",
});

Python Elasticsearch Python Client

resp = client.transform.set_upgrade_mode(
    enabled=True,
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_transform/set_upgrade_mode?enabled=true" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.transform().setUpgradeMode(s -> s
    .enabled(true)
);

C# Elasticsearch .NET Client

var response = await client.TransformManagement
    .SetUpgradeModeAsync(d1 => d1
        .Enabled(true)
    );

PHP Elasticsearch PHP Client

$resp = $client->transform()->setUpgradeMode([
    "enabled" => "true",
]);

Ruby Elasticsearch Ruby Client

response = client.transform.set_upgrade_mode(
  enabled: "true"
)

Response

No example

Required authorization

Query Parameters { enabled , timeout , }

Response

Query Parameters