Pause Job - POST /jobs/<jobId>/pause

For cases where it is known that undesirable input data will be sent, it is possible to pause the job. This may happen, for example, with advanced warning of an application stress test.

Whilst a job is paused, it can still receive data but it will not generate anomalies nor update its model. The job status will be changed to PAUSED.

When a job is paused, model updates will cease at the end of the bucket following the request to pause. When resumed, model updates will start at next whole bucket of input data. If the pause or resume requests are received mid-bucket, the partial buckets are ignored. Any gaps in data between the pause and resume will be treated as planned downtime and ignored.

A PAUSED job must be resumed in order for it to start analyzing input data again.

Note

Jobs with a scheduler configured cannot be paused. Instead, please stop the scheduler.

Example

curl -X POST 'http://localhost:8080/engine/v2/jobs/my_job/pause'

Returns

The HTTP 200 status code if successful.

Errors

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