Elastic Stack

Elastic Stack (ELK Stack) ml data frame API

The ml data frame API from Elastic Stack (ELK Stack) — 12 operation(s) for ml data frame.

GitHub OpenAPI
Business capability
Artificial Intelligence Management BC-610.60

Operations 18

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /_ml/data_frame/analytics/{id} Get data frame analytics job configs by ID · Get data frame analytics job configuration info #
Ask an LLM
“What source, destination and analysis is a specific data frame analytics job configured with?”
“Can I fetch several data frame analytics jobs at once with a comma-separated list or wildcard?”
Tell an agent
Show the configuration of data frame analytics job {id}.
Get configs for the data frame analytics jobs matching {id}, excluding generated fields.
PUT /_ml/data_frame/analytics/{id} Create a data frame analytics job · Create a data frame analytics job #
Ask an LLM
“How do I set up outlier detection, regression or classification on an index?”
“Can I cap the memory a new data frame analytics job is allowed to use?”
Tell an agent
Create data frame analytics job {id} reading from {source}, writing to {dest}, running {analysis}.
Create analytics job {id} with a model memory limit of {model_memory_limit}.
DELETE /_ml/data_frame/analytics/{id} Delete a data frame analytics job · Delete a data frame analytics job #
Ask an LLM
“How do I remove a data frame analytics job I no longer need?”
“Can I force-delete a data frame analytics job that is still running?”
Tell an agent destructive · confirm first
Delete data frame analytics job {id}.
Force delete the analytics job {id} even though it is running.
POST /_ml/data_frame/_evaluate Evaluate data frame analytics results · Evaluate data frame analytics #
Ask an LLM
“How accurate is my classification model compared with the ground truth in its results index?”
“Can I compute evaluation metrics like AUC ROC or mean squared error on an analytics results index?”
Tell an agent
Evaluate the analytics results in index {index} using {evaluation}.
Compute evaluation metrics {evaluation} for index {index}, limited to documents matching {query}.
GET /_ml/data_frame/analytics/_explain Explain an unsaved analytics config via GET · Explain data frame analytics config #
Ask an LLM
“Before creating a job, which fields would a draft data frame analytics config include or skip, using the GET form?”
“What memory would a not-yet-created analytics job need, asked over GET?”
Tell an agent
Explain field selection and memory for a draft analytics config on {source} via GET.
Using the GET explain call, estimate memory for analysis {analysis} before I create the job.
POST /_ml/data_frame/analytics/_explain Explain an unsaved analytics config via POST · Explain data frame analytics config #
Ask an LLM
“Can I POST a draft analytics config and get back which fields it would analyze?”
“How much memory would a proposed analytics job need, sending the draft config by POST?”
Tell an agent
POST a draft analytics config with source {source} and dest {dest} and explain its field selection.
Send analysis {analysis} by POST to estimate its memory before creating a job.
GET /_ml/data_frame/analytics/{id}/_explain Explain an existing analytics job via GET · Explain data frame analytics config #
Ask an LLM
“Why were certain fields left out of an existing data frame analytics job, checked with GET?”
“What memory does an already-created analytics job estimate it needs, via the GET explain?”
Tell an agent
Explain the field selection of existing analytics job {id} using GET.
GET the memory estimate for data frame analytics job {id}.
POST /_ml/data_frame/analytics/{id}/_explain Explain an existing analytics job via POST · Explain data frame analytics config #
Ask an LLM
“Can I POST to explain an existing analytics job, overriding some of its settings in the body?”
“How would changing analyzed_fields affect an existing job's memory estimate, sent by POST?”
Tell an agent
POST an explain for analytics job {id} with analyzed fields {analyzed_fields}.
Explain existing job {id} by POST and report the estimated memory.
GET /_ml/data_frame/analytics List all data frame analytics jobs · Get data frame analytics job configuration info #
Ask an LLM
“What data frame analytics jobs exist on my cluster?”
“Can I page through all analytics job configurations using from and size?”
Tell an agent
List every data frame analytics job configuration.
Show {size} data frame analytics jobs starting at {from}.
GET /_ml/data_frame/analytics/_stats Get stats for all data frame analytics jobs · Get data frame analytics job stats #
Ask an LLM
“What is the progress and state of all my data frame analytics jobs?”
“Can I get verbose statistics across every analytics job at once?”
Tell an agent
Show usage stats and progress for all data frame analytics jobs.
Get verbose stats for every analytics job, {size} at a time.
GET /_ml/data_frame/analytics/{id}/_stats Get stats for a data frame analytics job · Get data frame analytics job stats #
Ask an LLM
“How far along is a particular data frame analytics job?”
“Is a specific analytics job running, stopped or failed?”
Tell an agent
Show the progress and state of analytics job {id}.
Get verbose stats for data frame analytics job {id}.
GET /_ml/data_frame/analytics/_preview Preview features for a draft config via GET · Preview features used by data frame analytics #
Ask an LLM
“What extracted feature values would a draft analytics config produce, previewed with GET?”
“Can I sample the training features of a config I haven't saved yet using a GET request?”
Tell an agent
Preview the extracted features for draft config {config} via GET.
GET a feature preview for this unsaved analytics config {config}.
POST /_ml/data_frame/analytics/_preview Preview features for a draft config via POST · Preview features used by data frame analytics #
Ask an LLM
“Can I POST a draft analytics config and see sample extracted features?”
“What would the feature rows look like for a proposed config sent by POST?”
Tell an agent
POST draft config {config} and show me the extracted feature preview.
Preview features of proposed analytics config {config} with a POST request.
GET /_ml/data_frame/analytics/{id}/_preview Preview features of an existing job via GET · Preview features used by data frame analytics #
Ask an LLM
“What feature values does an existing analytics job extract, previewed via GET?”
“Can I check the training data an existing job will see before starting it, using GET?”
Tell an agent
GET a feature preview for analytics job {id}.
Show sample extracted features for existing job {id} via GET.
POST /_ml/data_frame/analytics/{id}/_preview Preview features of an existing job via POST · Preview features used by data frame analytics #
Ask an LLM
“Can I preview an existing analytics job's features with a POST request?”
“What rows would an existing job extract, fetched by POST?”
Tell an agent
POST a feature preview request for analytics job {id}.
Preview extracted features for existing job {id} using POST.
POST /_ml/data_frame/analytics/{id}/_start Start a data frame analytics job · Start a data frame analytics job #
Ask an LLM
“How do I kick off a data frame analytics job I've created?”
“Can I restart an analytics job after stopping it?”
Tell an agent
Start data frame analytics job {id}.
Start analytics job {id} and wait up to {timeout} for it to begin.
POST /_ml/data_frame/analytics/{id}/_stop Stop data frame analytics jobs · Stop data frame analytics jobs #
Ask an LLM
“How can I pause a running data frame analytics job?”
“Is there a force option to stop an analytics job that won't stop cleanly?”
Tell an agent
Stop data frame analytics job {id}.
Force stop analytics job {id} within {timeout}.
POST /_ml/data_frame/analytics/{id}/_update Update a data frame analytics job · Update a data frame analytics job #
Ask an LLM
“Can I raise the memory limit on an analytics job after creating it?”
“Which settings of a data frame analytics job can I change, like description or max threads?”
Tell an agent
Update analytics job {id} to a model memory limit of {model_memory_limit}.
Change the description of analytics job {id} to {description}.

Documentation

📖
Documentation
https://www.elastic.co/docs/reference/elasticsearch
📖
APIReference
https://www.elastic.co/docs/api/doc/elasticsearch/
📖
Documentation
https://www.elastic.co/docs/reference/kibana
📖
APIReference
https://www.elastic.co/docs/api/doc/kibana/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-ml-data-frame-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/elastic/elasticsearch-specification
🔗
SourceCode
https://github.com/elastic/kibana
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/mcp/elk-stack-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/elk-stack:elk-stack-ml-data-frame-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

elk-stack-ml-data-frame-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Elasticsearch Request & Response Specification ml data…
  license:
    name: Apache 2.0
    url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE
  version: ''
tags:


# --- truncated at 32 KB (435 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-ml-data-frame-api-openapi.yml