Validate Detectors

The validate detectors API validates detector configuration information.

Request

POST _xpack/ml/anomaly_detectors/_validate/detector

Description

This API enables you validate the detector configuration before you create a job.

Warning

This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Request Body

For a list of the properties that you can specify in the body of this API, see detector configuration objects.

Authorization

You must have manage_ml, or manage cluster privileges to use this API. For more information, see Cluster Privileges.

Examples

The 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
}