WARNING: Version 6.2 of the Elastic Stack has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
API Quick Reference
editAPI Quick Reference
editAll machine learning endpoints have the following base:
/_xpack/ml/
The main machine learning resources can be accessed with a variety of endpoints:
-
/anomaly_detectors/: Create and manage machine learning jobs -
/datafeeds/: Select data from Elasticsearch to be analyzed -
/results/: Access the results of a machine learning job -
/model_snapshots/: Manage model snapshots
/anomaly_detectors/
edit- PUT /anomaly_detectors/<job_id>: Create a job
- POST /anomaly_detectors/<job_id>/_open: Open a job
- POST /anomaly_detectors/<job_id>/_data: Send data to a job
- GET /anomaly_detectors: List jobs
- GET /anomaly_detectors/<job_id>: Get job details
- GET /anomaly_detectors/<job_id>/_stats: Get job statistics
- POST /anomaly_detectors/<job_id>/_update: Update certain properties of the job configuration
- POST anomaly_detectors/<job_id>/_flush: Force a job to analyze buffered data
- POST anomaly_detectors/<job_id>/_forecast: Forecast future job behavior
- POST /anomaly_detectors/<job_id>/_close: Close a job
- DELETE /anomaly_detectors/<job_id>: Delete a job
/calendars/
edit- PUT /calendars/<calendar_id>: Create a calendar
- POST /calendars/<calendar_id>/events: Add a scheduled event to a calendar
- PUT /calendars/<calendar_id>/jobs/<job_id>: Associate a job with a calendar
- GET /calendars/<calendar_id>: Get calendar details
- GET /calendars/<calendar_id>/events: Get scheduled event details
- DELETE /calendars/<calendar_id>/events/<event_id>: Remove a scheduled event from a calendar
- DELETE /calendars/<calendar_id>/jobs/<job_id>: Disassociate a job from a calendar
- DELETE /calendars/<calendar_id>: Delete a calendar
/datafeeds/
edit- PUT /datafeeds/<datafeed_id>: Create a datafeed
- POST /datafeeds/<datafeed_id>/_start: Start a datafeed
- GET /datafeeds: List datafeeds
- GET /datafeeds/<datafeed_id>: Get datafeed details
- GET /datafeeds/<datafeed_id>/_stats: Get statistical information for datafeeds
- GET /datafeeds/<datafeed_id>/_preview: Get a preview of a datafeed
- POST /datafeeds/<datafeedid>/_update: Update certain settings for a datafeed
- POST /datafeeds/<datafeed_id>/_stop: Stop a datafeed
- DELETE /datafeeds/<datafeed_id>: Delete datafeed
/results/
edit- GET /results/buckets: List the buckets in the results
- GET /results/buckets/<bucket_id>: Get bucket details
- GET /results/overall_buckets: Get overall bucket results for multiple jobs
- GET /results/categories: List the categories in the results
- GET /results/categories/<category_id>: Get category details
- GET /results/influencers: Get influencer details
- GET /results/records: Get records from the results
/model_snapshots/
edit- GET /model_snapshots: List model snapshots
- GET /model_snapshots/<snapshot_id>: Get model snapshot details
- POST /model_snapshots/<snapshot_id>/_revert: Revert a model snapshot
- POST /model_snapshots/<snapshot_id>/_update: Update certain settings for a model snapshot
- DELETE /model_snapshots/<snapshot_id>: Delete a model snapshot