Migrate Elasticsearch resource to use ILM

Base URL
https://api.elastic-cloud.com/api/v1
No auth

Migrates the specified Elasticsearch resource to use ILM.

Path parameters

deployment_id string required

Identifier for the Deployment.

ref_id string required

User-specified RefId for the Resource (or '_main' if there is only one).

Query parameters

validate_only boolean · default: false

When true, does not enable ILM but returns warnings if any applications may lose availability during ILM migration.

Request body

Information to build the ILM policies that will be created

index_patterns object[] required

A locally-unique user-specified id for Kibana

index_pattern string required

Index pattern to which the ILM policy will be applied.

policy_name string required

Name of the policy to create

node_attributes map string to string

Defines the Elasticsearch node attributes for the warm element of the topology

Responses

Standard response

application/json
warnings object[]

List of warnings generated from validating command

code string required

A structured code representing the error type that occurred

message string

A human readable message describing the warning that occurred

  • The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
  • The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

We have failed you. (code: deployments.deployment_resource_no_longer_exists)

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

Base URL
https://api.elastic-cloud.com/api/v1