WARNING: Version 5.4 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.
Validate Detectors
editValidate Detectors
editThe validate detectors API validates detector configuration information.
Request
editPOST _xpack/ml/anomaly_detectors/_validate/detector
Description
editThis API enables you validate the detector configuration before you create a job.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
Request Body
editFor a list of the properties that you can specify in the body of this API, see detector configuration objects.
Authorization
editYou must have manage_ml, or manage cluster privileges to use this API.
For more information, see Cluster Privileges.
Examples
editThe following example validates detector configuration information:
POST _xpack/ml/anomaly_detectors/_validate/detector
{
"function": "metric",
"field_name": "responsetime",
"by_field_name": "airline"
}
When the validation completes, you receive the following results:
{
"acknowledged": true
}