Starting and Pause Multiple Jobs Using REST API
Learn how to start and pause migration jobs using the DryvIQ REST API.
Table of Contents
Overview
DryvIQ supports starting and pausing multiple jobs at once. This feature also allows you to filter the full list of jobs by search criteria or start/pausing all jobs. The syntax for starting and pausing jobs is very similar. The filtering options outlined in the examples apply to both actions.
By default, DryvIQ will run 6 jobs in parallel. For example, if you start 15 jobs at once, only the first 6 will execute. The rest will be in the queue to start as the others finish
Start all jobs
In this example, all jobs will be started.
PATCH {{url}}v1/jobs?start
Pause all jobs
In this example, all jobs will be paused.
PATCH {{url}}v1/jobs?pause
Start Jobs Using Search Text to Filter Jobs
In this example, all jobs with the word "testjob" will be started.
PATCH {{url}}v1/jobs?q=testjob&start
Start Jobs Using an Offset and Limit to Filter Jobs
The offset lets you skip a set number of jobs. The limit determines the number of jobs that will start. In this example, the search skips the first seven jobs and starts the following five jobs.
PATCH {{url}}v1/jobs?offset=7&limit=5&start
Start Jobs Under a Parent Job
In this scenario, all jobs with the specified parent job ID will be started.
PATCH {{url}}v1/jobs?parent=123&start