WARNING: Version 5.4 of the Elastic Stack has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

› › ›

Validate Jobs

edit

Validate Jobs

edit

The validate jobs API validates job configuration information.

Request

edit

POST _xpack/ml/anomaly_detectors/_validate

Description

edit

This API enables you validate the job configuration before you create the 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 Job Resources.

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

« Validate Detectors Definitions »