OpenSearch/docs/en/rest-api/ml/validate-detector.asciidoc

//lcawley Verified example output 2017-04-11
[[ml-valid-detector]]
==== 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.

You must have `manage_ml`, or `manage` cluster privileges to use this API.
For more information, see <<privileges-list-cluster>>.

////
===== Path Parameters

////
===== Request Body

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

////
===== Responses

200
(EmptyResponse) The cluster has been successfully deleted
404
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: clusters.cluster_not_found)
412
(BasicFailedReply) The Elasticsearch cluster has not been shutdown yet (code: clusters.cluster_plan_state_error)
////
===== Examples

The following example validates detector configuration information:

[source,js]
--------------------------------------------------
POST _xpack/ml/anomaly_detectors/_validate/detector
{
  "function": "metric",
  "field_name": "responsetime",
  "by_field_name": "airline"
}
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]

When the validation completes, you receive the following results:
[source,js]
----
{
  "acknowledged": true
}
----