It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Migrate Elasticsearch resource to use ILMedit
Migrates the specified Elasticsearch resource to use ILM.
Requestedit
POST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
User-specified RefId for the Resource. |
Request bodyedit
(EnableIlmRequest) (required) Information to build the ILM policies that will be created
Responsesedit
-
200 -
(
DeploymentResourceCommandResponse) Standard response -
404 -
(
BasicFailedReply) * 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)Headers
-
x-cloud-error-codes(string; allowed values: [deployments.deployment_not_found,deployments.deployment_resource_not_found]) - The error codes associated with the response
-
-
449 -
(
BasicFailedReply) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]) - The error codes associated with the response
-
-
500 -
(
BasicFailedReply) We have failed you. (code:deployments.deployment_resource_no_longer_exists)Headers
-
x-cloud-error-codes(string; allowed values: [deployments.deployment_resource_no_longer_exists]) - The error codes associated with the response
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
"index_patterns" : [
{
"index_pattern" : "string",
"node_attributes" : {
"some_property" : "string"
},
"policy_name" : "string"
}
]
}
'