Update Job - PUT /jobs/<jobId>/update

A limited set of job properties are mutable and can be updated using this endpoint.

Important

Updates will not take effect until after the job has been CLOSED and new data sent to it.

Example

The HTTP Content-Type header must be set to application/json.

Updating job description:

curl -X PUT -H 'Content-Type: application/json' 'http://localhost:8080/engine/v2/jobs/my_job/update' -d '
{
   "description" : "A better description of the job"
}'

Request Body

The following properties can be updated after the job has been created:

  • analysisLimits - Overwrite the existing analysisLimits. Can only be updated while the job is closed. Note that modelMemoryLimit cannot be decreased. Increasing modelMemoryLimit after memoryStatus has reached HARD_LIMIT is not recommended.
  • backgroundPersistInterval - Frequency in seconds between periodic persistence of the model snapshots.
  • categorizationFilters - Change the filters applied in categorization.
  • customSettings - Define custom URLs linking from anomaly results to source data.
  • description - A friendly job description.
  • detectors.detectorDescription - A friendly detector description.
  • ignoreDowntime - Controls if gaps in data are treated as anomalous or as a maintenance window after a job re-start.
  • modelDebugConfig - Additionally stores model information along with results. See further examples below and Model debug (modelDebugConfig).
  • modelSnapshotRetentionDays - Time in days for which to retain saved model snapshots for this job.
  • renormalizationWindowDays - Period over which Anomaly Scores are updated due to re-normalization calculations.
  • resultsRetentionDays - Time in days for which to retain job results.
  • schedulerConfig - Overwrite the existing schedulerConfig. Can only be updated while the scheduler is stopped. Note that the dataSource cannot be changed.

Returns

The HTTP 200 status code if successful.

{ "acknowledgement": true }

Errors

Attempting to update a property that is not mutable will return an error. Passing invalid JSON or a value that is invalid for a property will also result to error.

See the Error Codes documentation for the full list of errors that may be returned by the API.

Further Examples

Model debug

Updating model debug:

curl -X PUT -H 'Content-Type: application/json' 'http://localhost:8080/engine/v2/jobs/my_job/update' -d '
{
   "modelDebugConfig": {
      "boundsPercentile": 95.0,
      "writeTo": "data_store"
   }
}'

Disabling model debug:

curl -X PUT -H 'Content-Type: application/json' 'http://localhost:8080/engine/v2/jobs/my_job/update' -d '
{
   "modelDebugConfig":null
}'