ml.stop_data_frame_analytics.json

{
  "ml.stop_data_frame_analytics": {
    "documentation": {
      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html",
      "description": "Stops one or more data frame analytics jobs."
    },
    "stability": "stable",
    "visibility": "public",
    "headers": {
      "accept": ["application/json"],
      "content_type": ["application/json"]
    },
    "url": {
      "paths": [
        {
          "path": "/_ml/data_frame/analytics/{id}/_stop",
          "methods": ["POST"],
          "parts": {
            "id": {
              "type": "string",
              "description": "The ID of the data frame analytics to stop"
            }
          }
        }
      ]
    },
    "params": {
      "allow_no_match": {
        "type": "boolean",
        "required": false,
        "description": "Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)"
      },
      "force": {
        "type": "boolean",
        "required": false,
        "description": "True if the data frame analytics should be forcefully stopped"
      },
      "timeout": {
        "type": "time",
        "required": false,
        "description": "Controls the time to wait until the task has stopped. Defaults to 20 seconds"
      }
    },
    "body": {
      "description": "The stop data frame analytics parameters"
    }
  }
}