Get deprecation information Added in 6.1.0

GET /{index}/_migration/deprecations

Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.

TIP: This APIs is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant.

Path parameters

  • index string Required

    Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • cluster_settings array[object] Required

      Cluster-level deprecation warnings.

      Hide cluster_settings attributes Show cluster_settings attributes object
      • details string

        Optional details about the deprecation warning.

      • level string Required

        Values are none, info, warning, or critical.

      • message string Required

        Descriptive information about the deprecation warning.

      • url string Required

        A link to the breaking change documentation, where you can find more information about this change.

      • _meta object
        Hide _meta attribute Show _meta attribute object
        • * object Additional properties

          Additional properties are allowed.

    • index_settings object Required

      Index warnings are sectioned off per index and can be filtered using an index-pattern in the query. This section includes warnings for the backing indices of data streams specified in the request path.

      Hide index_settings attribute Show index_settings attribute object
      • * array[object] Additional properties
        Hide * attributes Show * attributes object
        • details string

          Optional details about the deprecation warning.

        • level string Required

          Values are none, info, warning, or critical.

        • message string Required

          Descriptive information about the deprecation warning.

        • url string Required

          A link to the breaking change documentation, where you can find more information about this change.

        • _meta object
          Hide _meta attribute Show _meta attribute object
          • * object Additional properties

            Additional properties are allowed.

    • data_streams object Required
      Hide data_streams attribute Show data_streams attribute object
      • * array[object] Additional properties
        Hide * attributes Show * attributes object
        • details string

          Optional details about the deprecation warning.

        • level string Required

          Values are none, info, warning, or critical.

        • message string Required

          Descriptive information about the deprecation warning.

        • url string Required

          A link to the breaking change documentation, where you can find more information about this change.

        • _meta object
          Hide _meta attribute Show _meta attribute object
          • * object Additional properties

            Additional properties are allowed.

    • node_settings array[object] Required

      Node-level deprecation warnings. Since only a subset of your nodes might incorporate these settings, it is important to read the details section for more information about which nodes are affected.

      Hide node_settings attributes Show node_settings attributes object
      • details string

        Optional details about the deprecation warning.

      • level string Required

        Values are none, info, warning, or critical.

      • message string Required

        Descriptive information about the deprecation warning.

      • url string Required

        A link to the breaking change documentation, where you can find more information about this change.

      • _meta object
        Hide _meta attribute Show _meta attribute object
        • * object Additional properties

          Additional properties are allowed.

    • ml_settings array[object] Required

      Machine learning-related deprecation warnings.

      Hide ml_settings attributes Show ml_settings attributes object
      • details string

        Optional details about the deprecation warning.

      • level string Required

        Values are none, info, warning, or critical.

      • message string Required

        Descriptive information about the deprecation warning.

      • url string Required

        A link to the breaking change documentation, where you can find more information about this change.

      • _meta object
        Hide _meta attribute Show _meta attribute object
        • * object Additional properties

          Additional properties are allowed.

GET /{index}/_migration/deprecations
curl \
 -X GET http://api.example.com/{index}/_migration/deprecations
Response examples (200)
{
  "cluster_settings": [
    {
      "details": "string",
      "level": "none",
      "message": "string",
      "url": "string",
      "resolve_during_rolling_upgrade": true,
      "_meta": {
        "additionalProperty1": {},
        "additionalProperty2": {}
      }
    }
  ],
  "index_settings": {
    "additionalProperty1": [
      {
        "details": "string",
        "level": "none",
        "message": "string",
        "url": "string",
        "resolve_during_rolling_upgrade": true,
        "_meta": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        }
      }
    ],
    "additionalProperty2": [
      {
        "details": "string",
        "level": "none",
        "message": "string",
        "url": "string",
        "resolve_during_rolling_upgrade": true,
        "_meta": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        }
      }
    ]
  },
  "data_streams": {
    "additionalProperty1": [
      {
        "details": "string",
        "level": "none",
        "message": "string",
        "url": "string",
        "resolve_during_rolling_upgrade": true,
        "_meta": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        }
      }
    ],
    "additionalProperty2": [
      {
        "details": "string",
        "level": "none",
        "message": "string",
        "url": "string",
        "resolve_during_rolling_upgrade": true,
        "_meta": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        }
      }
    ]
  },
  "node_settings": [
    {
      "details": "string",
      "level": "none",
      "message": "string",
      "url": "string",
      "resolve_during_rolling_upgrade": true,
      "_meta": {
        "additionalProperty1": {},
        "additionalProperty2": {}
      }
    }
  ],
  "ml_settings": [
    {
      "details": "string",
      "level": "none",
      "message": "string",
      "url": "string",
      "resolve_during_rolling_upgrade": true,
      "_meta": {
        "additionalProperty1": {},
        "additionalProperty2": {}
      }
    }
  ]
}