This is an archive version of the document. To get the most up-to-date information, see the current version.Operations and Methods
The following method-implemented operations are supported for the jobs entity in Veeam Service Provider Console RESTful API:
- Get All Jobs — retrieve a collection resource representation of all jobs on all Veeam Backup & Replication servers.
- Get All Jobs Configured on Backup Server — retrieve a collection resource representation of all jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get Job — retrieve a resource representation of a job with the specified UID.
- Modify Job — modify a job with the specified UID.
- Start Job — start a job with the specified UID.
- Stop Job — stop a job with the specified UID.
- Retry Job — retry a job with the specified UID.
- Get All VM Backup Jobs — retrieve a collection resource representation of all backup jobs that protect virtual machines.
- Get VM Backup Job — retrieve a resource representation of a backup job with the specified UID that protects virtual machines.
- Get All VM Backup Jobs Configured on Backup Server — retrieve a collection resource representation of all VM backup jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Objects of VM Backup Jobs Configured on Backup Server — retrieve a collection resource representation of all objects of VM backup jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Objects of VM Backup Jobs — retrieve a collection resource representation of all VM backup job objects.
- Get All Objects of VM Backup Job — retrieve a collection resource representation of all objects of a VM backup job with the specified UID.
- Get All VM Replication Jobs — retrieve a resource representation of all replication jobs that protects virtual machines.
- Get VM Replication Job — retrieve a resource representation of a replication job with the specified UID that protects virtual machines.
- Get All VM Replication Jobs Configured on Backup Server — retrieve a collection resource representation of all VM replication jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Objects of VM Replication Jobs Configured on Backup Server — retrieve a collection resource representation of all objects of VM replication jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Objects of VM Replication Jobs — retrieve a collection resource representation of all VM replication job objects.
- Get All Objects of VM Replication Job — retrieve a collection resource representation of all objects of a VM replication job with the specified UID.
- Get All Backup Copy Jobs — retrieve a collection resource representation of all backup copy jobs.
- Get Backup Copy Job — retrieve a resource representation of a backup copy job with the specified UID.
- Get All Backup Copy Jobs Configured on Backup Server — retrieve a collection resource representation of all backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Objects of Backup Copy Jobs — retrieve a collection resource representation of all backup copy job objects.
- Get All Objects of Backup Copy Job — retrieve a collection resource representation of all objects of a backup copy job with the specified UID.
- Get All Objects of Backup Copy Jobs Configured on Backup Server — retrieve a collection resource representation of all objects of backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All File Share Jobs — retrieve a collection resource representation of all file share jobs.
- Get File Share Job — retrieve a resource representation of a file share job with the specified UID.
- Get All File Share Jobs Configured on Backup Server — retrieve a collection resource representation of all file share jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Objects of File Share Jobs — retrieve a collection resource representation of all file share job objects.
- Get All Objects of File Share Jobs Configured on Backup Server — retrieve a collection resource representation of all objects of file share jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Objects of File Share Job — retrieve a collection resource representation of all objects of a file share job with the specified UID.
- Get All File Share Copy Jobs — retrieve a collection resource representation of all backup copy jobs for file shares.
- Get File Share Copy Job — retrieve a resource representation of a file share backup copy job with the specified UID.
- Get All File Share Copy Jobs Configured on Backup Server — retrieve a collection resource representation of all file share backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Objects of File Share Copy Jobs — retrieve a collection resource representation of all file share backup copy job objects.
- Get All Objects of File Share Copy Jobs Configured on Backup Server — retrieve a collection resource representation of all objects of file share backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Objects of File Share Copy Job — retrieve a collection resource representation of all objects of a file share backup copy job with the specified UID.
- Get All Immediate Backup Copy Jobs — retrieve a collection resource representation of all immediate backup copy jobs.
- Get Immediate Backup Copy Job — retrieve a resource representation of an immediate backup copy job with the specified UID.
- Get All Immediate Backup Copy Jobs Configured on Backup Server — retrieve a collection resource representation of all immediate backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Objects of Immediate Backup Copy Jobs — retrieve a collection resource representation of all immediate backup copy job objects.
- Get All Objects of Immediate Backup Copy Job — retrieve a collection resource representation of all objects of an immediate backup copy job with the specified UID.
- Get All Objects of Immediate Backup Copy Jobs Configured on Backup Server — retrieve a collection resource representation of all objects of immediate backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All VM Copy Jobs — retrieve a collection resource representation of all VM copy jobs.
- Get VM Copy Job — retrieve a resource representation of a VM copy job with the specified UID.
- Get All VM Copy Jobs Configured on Backup Server — retrieve a collection resource representation of all VM copy jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All File Copy Jobs — retrieve a collection resource representation of all file copy jobs.
- Get File Copy Job — retrieve a resource representation of a file copy job with the specified UID.
- Get All File Copy Jobs Configured on Backup Server — retrieve a collection resource representation of all file copy jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All File to Tape Jobs — retrieve a collection resource representation of all file to tape jobs.
- Get File to Tape Job — retrieve a resource representation of a file to tape job with the specified UID.
- Get All File to Tape Jobs Configured on Backup Server — retrieve a collection resource representation of all file to tape jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Objects of File to Tape Jobs — retrieve a collection resource representation of all file to tape job objects.
- Get All Objects of File to Tape Jobs Configured on Backup Server — retrieve a collection resource representation of all objects of file to tape jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Objects of File to Tape Job — retrieve a collection resource representation of all objects of a file to tape job with the specified UID.
- Get All Backup to Tape Jobs — retrieve a collection resource representation of all backup to tape jobs.
- Get Backup to Tape Job — retrieve a resource representation of a backup to tape job with the specified UID.
- Get All Backup to Tape Jobs Configured on Backup Server — retrieve a collection resource representation of all backup to tape jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Job Objects of Backup to Tape Jobs — retrieve a collection resource representation of all jobs processed by backup to tape jobs.
- Get All Job Objects of Backup to Tape Jobs Configured on Backup Server — retrieve a collection resource representation of all jobs that are processed by backup to tape jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Job Objects of Backup to Tape Job — retrieve a collection resource representation of all jobs processed by a backup to tape job with the specified UID.
- Get All Repository Objects of Backup to Tape Jobs — retrieve a collection resource representation of all repositories processed by backup to tape jobs.
- Get All Repository Objects of Backup to Tape Jobs Configured on Backup Server — retrieve a collection resource representation of all repositories that are processed by backup to tape jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get All Repository Objects of Backup to Tape Job — retrieve a collection resource representation of all repositories processed by a backup to tape job with the specified UID.
- Get All Backup Agent Jobs — retrieve a collection resource representation of all backup agent jobs.
- Get All Backup Agent Jobs Configured on Backup Server — retrieve a collection resource representation of all backup agent jobs configured on a Veeam Backup & Replication server with the specified UID.
- Get Backup Agent Job — retrieve a resource representation of a backup agent job with the specified UID.
- Get All Objects of Backup Agent Job — retrieve a collection resource representation of all objects of a backup agent job with the specified UID.
- Get All Objects of Backup Agent Jobs — retrieve a collection resource representation of all backup agent job objects.