OpenSearch/docs/reference/ml/anomaly-detection/apis/validate-job.asciidoc

[role="xpack"]
[testenv="platinum"]
[[ml-valid-job]]
=== Validate jobs API
++++
<titleabbrev>Validate jobs</titleabbrev>
++++

Validates job configuration information.

[[ml-valid-job-request]]
==== {api-request-title}

`POST _ml/anomaly_detectors/_validate`

[[ml-valid-job-prereqs]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See
{stack-ov}/security-privileges.html[Security privileges].

[[ml-valid-job-desc]]
==== {api-description-title}

The validate jobs API enables you validate the job configuration before you
create the job.

[[ml-valid-job-request-body]]
==== {api-request-body-title}

For a list of the properties that you can specify in the body of this API,
see <<ml-job-resource,Job Resources>>.

[[ml-valid-job-example]]
==== {api-examples-title}

The following example validates job configuration information:

[source,js]
--------------------------------------------------
POST _ml/anomaly_detectors/_validate
{
    "description" : "Unusual response times by airlines",
    "analysis_config" : {
        "bucket_span": "300S",
        "detectors" :[
          {
            "function": "metric",
            "field_name": "responsetime",
            "by_field_name": "airline"}],
            "influencers": [ "airline" ]
    },
    "data_description" : {
       "time_field": "time",
       "time_format": "yyyy-MM-dd'T'HH:mm:ssX"
    }
}
--------------------------------------------------
// CONSOLE
// TEST[skip:needs-licence]

When the validation is complete, you receive the following results:
[source,js]
----
{
  "acknowledged": true
}
----
// TESTRESPONSE