- X-Pack Reference for 6.0-6.2 and 5.x:
- Introduction
- Setting Up X-Pack
- Breaking Changes
- X-Pack APIs
- Graphing Connections in Your Data
- Profiling your Queries and Aggregations
- Reporting from Kibana
- Securing Elasticsearch and Kibana
- Monitoring the Elastic Stack
- Alerting on Cluster and Index Events
- Machine Learning in the Elastic Stack
- Troubleshooting
- Getting Help
- X-Pack security
- Can’t log in after upgrading to 6.0.1
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- X-Pack Watcher
- X-Pack monitoring
- X-Pack machine learning
- Limitations
- License Management
- Release Notes
WARNING: Version 6.0 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>/_close: Close a job
- DELETE /anomaly_detectors/<job_id>: Delete a job
/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/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
Was this helpful?
Thank you for your feedback.