Migrate Elasticsearch resource to use ILM

View as Markdown
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm
Basic auth Api key

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

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

    Default value is false.

application/json

Body Required

Information to build the ILM policies that will be created

  • index_patterns array[object] Required

    A locally-unique user-specified id for Kibana

    An index pattern described indicating how it has to be migrated to ILM.

    Hide index_patterns attributes Show index_patterns attributes object
    • 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 object

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

      Hide node_attributes attribute Show node_attributes attribute object
      • * string Additional properties

Responses

  • 200 application/json

    Standard response

    Hide response attribute Show response attribute object
    • warnings array[object]

      List of warnings generated from validating command

      Hide warnings attributes Show warnings attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string

        A human readable message describing the warning that occurred
  • 404 application/json
    • 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)
    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Values are deployments.deployment_not_found or deployments.deployment_resource_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • 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 array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
  • 500 application/json

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

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is deployments.deployment_resource_no_longer_exists.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • 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 array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm 
curl \ --request POST 'https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm' \ --user "username:password" \ --header "Content-Type: application/json" \ --data '{"index_patterns":[{"index_pattern":"string","policy_name":"string","node_attributes":{"additionalProperty1":"string","additionalProperty2":"string"}}]}'