AuthThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.AvailabilityGenerally available since 7.3This functionality is generally available and ready for production usage.Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
A data frame analytics job can be started and stopped multiple times
throughout its lifecycle.
Identifier for the data frame analytics job. This identifier can contain
lowercase alphanumeric characters (a-z and 0-9), hyphens, and
underscores. It must start and end with alphanumeric characters.
Contains wildcard expressions and there are no data frame analytics
jobs that match.
Contains the _all string or no identifiers and there are no matches.
Contains wildcard expressions and there are only partial matches.
The default value is true, which returns an empty data_frame_analytics
array when there are no matches and the subset of results when there are
partial matches. If this parameter is false, the request returns a 404
status code when there are no matches or only partial matches.
forceboolean · default: false
If true, the data frame analytics job is stopped forcefully.
timeoutstring · default: 20s
Controls the amount of time to wait until the data frame analytics job
stops. Defaults to 20 seconds.
If provided, must be the same identifier as in the path.
allow_no_matchboolean · default: true
Specifies what to do when the request:
Contains wildcard expressions and there are no data frame analytics
jobs that match.
Contains the _all string or no identifiers and there are no matches.
Contains wildcard expressions and there are only partial matches.
The default value is true, which returns an empty data_frame_analytics
array when there are no matches and the subset of results when there are
partial matches. If this parameter is false, the request returns a 404
status code when there are no matches or only partial matches.
forceboolean · default: false
If true, the data frame analytics job is stopped forcefully.
timeoutstring · default: 20s
Controls the amount of time to wait until the data frame analytics job
stops. Defaults to 20 seconds.