Path parameters

• job_idstring | array[string] Required

  Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. If you do not specify one of these options, the API returns information for all anomaly detection jobs.

Query parameters

• allow_no_matchboolean

  Specifies what to do when the request:

  1. Contains wildcard expressions and there are no jobs that match.
  2. Contains the _all string or no identifiers and there are no matches.
  3. Contains wildcard expressions and there are only partial matches.

  The default value is true, which returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

• exclude_generatedboolean

  Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • countnumber Required
  • jobsarray[object] Required
    Hide jobs attributes Show jobs attributes object

    • allow_lazy_openboolean Required

      Advanced configuration option. Specifies whether this job can open when there is insufficient machine learning node capacity for it to be immediately assigned to a node.

    • analysis_configobject Required
      Hide analysis_config attributes Show analysis_config attributes object

      • bucket_spanstring

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

      • categorization_analyzerstring | object

        One of:

        CategorizationAnalyzerstringCategorizationAnalyzerDefinitionobject

        Hide attributes Show attributes

        • char_filterarray

          One or more character filters. In addition to the built-in character filters, other plugins can provide more character filters. If this property is not specified, no character filters are applied prior to categorization. If you are customizing some other aspect of the analyzer and you need to achieve the equivalent of categorization_filters (which are not permitted when some other aspect of the analyzer is customized), add them here as pattern replace character filters.

        • filterarray

          One or more token filters. In addition to the built-in token filters, other plugins can provide more token filters. If this property is not specified, no token filters are applied prior to categorization.

        • tokenizer
      • categorization_field_namestring

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • categorization_filtersarray[string]

        If categorization_field_name is specified, you can also define optional filters. This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, use the categorization_analyzer property instead and include the filters as pattern_replace character filters. The effect is exactly the same.

      • detectorsarray[object] Required

        Detector configuration objects specify which data fields a job analyzes. They also specify which analytical functions are used. You can specify multiple detectors for a job. If the detectors array does not contain at least one detector, no analysis can occur and an error is returned.

        Hide detectors attributes Show detectors attributes object

        • by_field_namestring

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • custom_rulesarray[object]

          Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules.

        • detector_descriptionstring

          A description of the detector.

        • detector_indexnumber

          A unique identifier for the detector. This identifier is based on the order of the detectors in the analysis_config, starting at zero. If you specify a value for this property, it is ignored.

        • exclude_frequentstring

          Values are all, none, by, or over.

        • field_namestring

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • functionstring

          The analysis function that is used. For example, count, rare, mean, min, max, or sum.

        • over_field_namestring

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • partition_field_namestring

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • use_nullboolean

          Defines whether a new series is used as the null series when there is no value for the by or partition fields.

      • influencersarray[string]

        A comma separated list of influencer field names. Typically these can be the by, over, or partition fields that are used in the detector configuration. You might also want to use a field name that is not specifically named in a detector, but is available as part of the input data. When you use multiple detectors, the use of influencers is recommended as it aggregates results for each influencer entity.

      • latencystring

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

      • model_prune_windowstring

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

      • multivariate_by_fieldsboolean

        This functionality is reserved for internal use. It is not supported for use in customer environments and is not subject to the support SLA of official GA features. If set to true, the analysis will automatically find correlations between metrics for a given by field value and report anomalies when those correlations cease to hold. For example, suppose CPU and memory usage on host A is usually highly correlated with the same metrics on host B. Perhaps this correlation occurs because they are running a load-balanced application. If you enable this property, anomalies will be reported when, for example, CPU usage on host A is high and the value of CPU usage on host B is low. That is to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU of host B. To use the multivariate_by_fields property, you must also specify by_field_name in your detector.

      • per_partition_categorizationobject
        Hide per_partition_categorization attributes Show per_partition_categorization attributes object

        • enabledboolean

          To enable this setting, you must also set the partition_field_name property to the same value in every detector that uses the keyword mlcategory. Otherwise, job creation fails.

        • stop_on_warnboolean

          This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly.

      • summary_count_field_namestring

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • analysis_limitsobject
      Hide analysis_limits attributes Show analysis_limits attributes object

      • categorization_examples_limitnumber

        The maximum number of examples stored per category in memory and in the results data store. If you increase this value, more examples are available, however it requires that you have more storage available. If you set this value to 0, no examples are stored. NOTE: The categorization_examples_limit applies only to analysis that uses categorization.

      • model_memory_limitnumber | string

        One of:

        ByteSizenumberByteSizestring
    • background_persist_intervalstring

      A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

    • blockedobject
      Hide blocked attributes Show blocked attributes object

      • reasonstring Required

        Values are delete, reset, or revert.

      • task_idstring | number

        One of:

        TaskIdstringTaskIdnumber

    • create_timestring | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:

      DateTimestringUnitMillisnumber

      Time unit for milliseconds

    • custom_settingsobject

      Custom metadata about the job

    • daily_model_snapshot_retention_after_daysnumber

      Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies a period of time (in days) after which only the first snapshot per day is retained. This period is relative to the timestamp of the most recent snapshot for this job. Valid values range from 0 to model_snapshot_retention_days.

    • data_descriptionobject Required
      Hide data_description attributes Show data_description attributes object

      • formatstring

        Only JSON format is supported at this time.

      • time_fieldstring

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • time_formatstring

        The time format, which can be epoch, epoch_ms, or a custom pattern. The value epoch refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value epoch_ms indicates that time is measured in milliseconds since the epoch. The epoch and epoch_ms time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: yyyy-MM-dd'T'HH:mm:ssX. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails.

      • field_delimiterstring
    • datafeed_configobject
      Hide datafeed_config attributes Show datafeed_config attributes object

      • aggregationsobject
      • authorizationobject
        Hide authorization attributes Show authorization attributes object

        • api_keyobject
          Hide api_key attributes Show api_key attributes object

          • idstring Required

            The identifier for the API key.

          • namestring Required

            The name of the API key.

        • rolesarray[string]

          If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response.

        • service_accountstring

          If a service account was used for the most recent update to the datafeed, the account name is listed in the response.

      • chunking_configobject
        Hide chunking_config attributes Show chunking_config attributes object

        • modestring Required

          Values are auto, manual, or off.

        • time_spanstring

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

      • datafeed_idstring Required
      • frequencystring

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

      • indicesarray[string] Required
      • indexesarray[string]
      • job_idstring Required
      • max_empty_searchesnumber
      • query_delaystring

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

      • script_fieldsobject
        Hide script_fields attribute Show script_fields attribute object

        • *object Additional properties
          Hide * attributes Show * attributes object

          • scriptobject Required
          • ignore_failureboolean
      • scroll_sizenumber
      • delayed_data_check_configobject Required
        Hide delayed_data_check_config attributes Show delayed_data_check_config attributes object

        • check_windowstring

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • enabledboolean Required

          Specifies whether the datafeed periodically checks for delayed data.

      • runtime_mappingsobject
        Hide runtime_mappings attribute Show runtime_mappings attribute object

        • *object Additional properties
          Hide * attributes Show * attributes object

          • fieldsobject

            For type composite

          • fetch_fieldsarray[object]

            For type lookup

          • formatstring

            A custom format for date type runtime fields.

          • input_fieldstring

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • target_fieldstring

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • target_indexstring
          • scriptobject
          • typestring Required

            Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.

      • indices_optionsobject
        Hide indices_options attributes Show indices_options attributes object

        • allow_no_indicesboolean

          If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

        • expand_wildcardsstring | array[string]
        • ignore_unavailableboolean

          If true, missing or closed indices are not included in the response.

        • ignore_throttledboolean

          If true, concrete, expanded or aliased indices are ignored when frozen.

      • queryobject Required

        The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {"boost": 1}}.

        Query DSL
    • deletingboolean

      Indicates that the process of deleting the job is in progress but not yet completed. It is only reported when true.

    • descriptionstring

      A description of the job.

    • finished_timestring | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:

      DateTimestringUnitMillisnumber

      Time unit for milliseconds

    • groupsarray[string]

      A list of job groups. A job can belong to no groups or many.

    • job_idstring Required
    • job_typestring

      Reserved for future use, currently set to anomaly_detector.

    • job_versionstring
    • model_plot_configobject
      Hide model_plot_config attributes Show model_plot_config attributes object

      • annotations_enabledboolean

        If true, enables calculation and storage of the model change annotations for each entity that is being analyzed.

      • enabledboolean

        If true, enables calculation and storage of the model bounds for each entity that is being analyzed.

      • termsstring

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • model_snapshot_idstring
    • model_snapshot_retention_daysnumber Required

      Advanced configuration option, which affects the automatic removal of old model snapshots for this job. It specifies the maximum period of time (in days) that snapshots are retained. This period is relative to the timestamp of the most recent snapshot for this job. By default, snapshots ten days older than the newest snapshot are deleted.

    • renormalization_window_daysnumber

      Advanced configuration option. The period over which adjustments to the score are applied, as new data is seen. The default value is the longer of 30 days or 100 bucket_spans.

    • results_index_namestring Required
    • results_retention_daysnumber

      Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained. Annotations generated by the system also count as results for retention purposes; they are deleted after the same number of days as results. Annotations added by users are retained forever.