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

[role="xpack"]
[[ml-valid-detector]]
=== Validate Detectors API
++++
<titleabbrev>Validate Detectors </titleabbrev>
++++

This API validates detector configuration information.

==== Request

`POST _xpack/ml/anomaly_detectors/_validate/detector`

==== Description

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


==== Request Body

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


==== Authorization

You must have `manage_ml`, or `manage` cluster privileges to use this API.
For more information, see
{xpack-ref}/security-privileges.html[Security Privileges].
//<<privileges-list-cluster>>.


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