Migrate Elasticsearch resource to use ILM
Migrates the specified Elasticsearch resource to use ILM.
Path parameters
-
Identifier for the Deployment.
-
User-specified RefId for the Resource (or '_main' if there is only one).
Query parameters
-
validate_only boolean
When
true
, does not enable ILM but returns warnings if any applications may lose availability during ILM migration.Default value is
false
.
Body Required
Information to build the ILM policies that will be created
-
A locally-unique user-specified id for Kibana
Responses
-
Standard response
-
- 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
)
- The Deployment specified by {deployment_id} cannot be found. (code:
-
We have failed you. (code:
deployments.deployment_resource_no_longer_exists
)
POST
/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm
curl \
-X POST https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm \
-d '{"index_patterns":[{"index_pattern":"string","policy_name":"string","node_attributes":{"additionalProperty1":"string","additionalProperty2":"string"}}]}'
Request examples
{
"index_patterns": [
{
"index_pattern": "string",
"policy_name": "string",
"node_attributes": {
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
]
}
Response examples (200)
{
"warnings": [
{
"code": "string",
"message": "string"
}
]
}
Response examples (404)
# Headers
x-cloud-error-codes: deployments.deployment_not_found
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
Response examples (500)
# Headers
x-cloud-error-codes: deployments.deployment_resource_no_longer_exists
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}