OpenSearch/docs/en/rest-api/ml/update-job.asciidoc

[role="xpack"]
[[ml-update-job]]
=== Update Jobs API
++++
<titleabbrev>Update Jobs</titleabbrev>
++++

This API enables you to update certain properties of a job.

==== Request

`POST _xpack/ml/anomaly_detectors/<job_id>/_update`


==== Path Parameters

`job_id` (required)::
  (string) Identifier for the job

==== Request Body

The following properties can be updated after the job is created:

[cols="<,<,<",options="header",]
|=======================================================================
|Name |Description |Requires Restart

|`analysis_limits`: `model_memory_limit` |The approximate maximum amount of
memory resources required for analytical processing. See <<ml-apilimits>>. | Yes

|`background_persist_interval` |Advanced configuration option. The time between
each periodic persistence of the model. See <<ml-job-resource>>. | Yes

|`custom_settings` |Contains custom meta data about the job. | No

|`description` |A description of the job. See <<ml-job-resource>>. | No

|`groups` |A list of job groups. See <<ml-job-resource>>. | No

|`model_plot_config`: `enabled` |If true, enables calculation and storage of the
model bounds for each entity that is being analyzed.
See <<ml-apimodelplotconfig>>. | No

|`model_snapshot_retention_days` |The time in days that model snapshots are
retained for the job. See <<ml-job-resource>>. | Yes

|`renormalization_window_days` |Advanced configuration option. The period over
which adjustments to the score are applied, as new data is seen.
See <<ml-job-resource>>. | Yes

|`results_retention_days` |Advanced configuration option. The number of days
for which job results are retained. See <<ml-job-resource>>. | Yes

|=======================================================================

For those properties that have `Requires Restart` set to `Yes` in this table,
if the job is open when you make the update, you must stop the data feed, close
the job, then restart the data feed and open the job for the changes to take
effect.

//|`analysis_config`: `detectors`: `detector_index` | A unique identifier of the
//detector. Matches the order of detectors returned by
//<<ml-get-job,GET job>>, starting from 0. | No
//|`analysis_config`: `detectors`: `detector_description` |A description of the
//detector. See <<ml-analysisconfig>>. | No

[NOTE]
--
* You can update the `analysis_limits` only while the job is closed.
* The `model_memory_limit` property value cannot be decreased.
* If the `memory_status` property in the `model_size_stats` object has a value
of `hard_limit`, this means that it was unable to process some data. You might
want to re-run this job with an increased `model_memory_limit`.
--


==== 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 updates the `it_ops_new_logs` job:

[source,js]
--------------------------------------------------
POST _xpack/ml/anomaly_detectors/it_ops_new_logs/_update
{
  "description":"An updated job",
  "groups": ["group1","group2"],
  "model_plot_config": {
    "enabled": true
  },
  "analysis_limits": {
    "model_memory_limit": "1024mb"
  },
  "renormalization_window_days": 30,
  "background_persist_interval": "2h",
  "model_snapshot_retention_days": 7,
  "results_retention_days": 60,
  "custom_settings": {
    "custom_urls" : [{
      "url_name" : "Lookup IP",
      "url_value" : "http://geoiplookup.net/ip/$clientip$"
    }]
  }
}
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]

When the job is updated, you receive a summary of the job configuration
information, including the updated property values. For example:

[source,js]
----
{
  "job_id": "it_ops_new_logs",
  "job_type": "anomaly_detector",
  "job_version": "7.0.0-alpha1",
  "groups": [
    "group1",
    "group2"
  ],
  "description": "An updated job",
  "create_time": 1502904685360,
  "analysis_config": {
    "bucket_span": "1800s",
    "categorization_field_name": "message",
    "detectors": [
      {
        "detector_description": "Unusual message counts",
        "function": "count",
        "by_field_name": "mlcategory",
        "rules": [],
        "detector_index": 0
      }
    ],
    "influencers": []
  },
  "analysis_limits": {
    "model_memory_limit": "1024mb"
  },
  "data_description": {
    "time_field": "time",
    "time_format": "epoch_ms"
  },
  "model_plot_config": {
    "enabled": true
  },
  "renormalization_window_days": 30,
  "background_persist_interval": "2h",
  "model_snapshot_retention_days": 7,
  "results_retention_days": 60,
  "custom_settings": {
    "custom_urls": [
      {
        "url_name": "Lookup IP",
        "url_value": "http://geoiplookup.net/ip/$clientip$"
      }
    ]
  },
  "model_snapshot_id": "1493678315",
  "results_index_name": "shared"
}
----