Validate Detectors

edit

The validate detectors API validates detector configuration information.

Request

edit

POST _xpack/ml/anomaly_detectors/_validate/detector

Description

edit

This 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

edit

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

Authorization

edit

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

Examples

edit

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
}