Validate Jobs

The validate jobs API validates job configuration information.

Request

POST _xpack/ml/anomaly_detectors/_validate

Description

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

Request Body

For a list of the properties that you can specify in the body of this API, see Job Resources.

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 job configuration information:

POST _xpack/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"
    }
}

When the validation is complete, you receive the following results:

{
  "acknowledged": true
}