rest-api-spec.api.ml.start_datafeed.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

Elasticsearch subproject :rest-api-spec

There is a newer version: 8.16.0

{
  "ml.start_datafeed":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html",
      "description":"Starts one or more datafeeds."
    },
    "stability":"stable",
    "visibility":"public",
    "headers":{
      "accept": [ "application/json"],
      "content_type": ["application/json"]
    },
    "url":{
      "paths":[
        {
          "path":"/_ml/datafeeds/{datafeed_id}/_start",
          "methods":[
            "POST"
          ],
          "parts":{
            "datafeed_id":{
              "type":"string",
              "description":"The ID of the datafeed to start"
            }
          }
        }
      ]
    },
    "params":{
      "start":{
        "type":"string",
        "required":false,
        "description":"The start time from where the datafeed should begin"
      },
      "end":{
        "type":"string",
        "required":false,
        "description":"The end time when the datafeed should stop. When not set, the datafeed continues in real time"
      },
      "timeout":{
        "type":"time",
        "required":false,
        "description":"Controls the time to wait until a datafeed has started. Default to 20 seconds"
      }
    },
    "body":{
      "description":"The start datafeed parameters"
    }
  }
}