Veeam Service Provider Console 9.3
REST API Reference
Related documents

Backup Server Jobs

This resource collection represents jobs configured on managed Veeam Backup & Replication servers.

Get All Jobs

Returns a collection resource representation of all jobs on all Veeam Backup & Replication servers.

Request
query Parameters
Array of objects or null (FilterParameter)

Specifies the conditions that a resource must meet to be returned in the output.

Array of objects or null (SortParameter)

Specifies the order in which resources are returned from the collection.

limit
integer <int32> [ 1 .. 500 ]
Default: 100

Specifies the first N resources that must be returned in the output.

offset
integer <int32> [ 0 .. 2147483647 ]
Default: 0

Excludes the first N resources from the query output.

Array of objects or null (SelectParameter)

Returns explicitly requested properties.

header Parameters
X-Request-id
string <uuid>

Random UID that you can assign to a request for idempotence and async action progress tracking.

Note that an operation is idempotent only during 5 minute time interval.

Example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string

Version of Veeam Service Provider Console RESTful API supported by client.

Example: 3.7
Responses
200

OK

202

Request has been queued for execution.

default

All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.

get/infrastructure/backupServers/jobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Jobs Configured on Backup Server
Returns a collection resource representation of all jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Job
Returns a resource representation of a job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Job
Modifies a job with the specified UID. Returns a positive response when the task is added to the internal queue and not when the task is executed.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/backupServers/jobs/{jobUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Job
Delete a job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/backupServers/jobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Assign Job to Company
Assign a job with the specified UID to a company.




Returns a positive response when the task is added to the internal queue and not when the task is executed.




Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
companyUid
required
string <uuid> 
Company UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/jobs/{jobUid}/assign
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Unassign Job from Company
Unassigns a job with the specified UID from a company.




Returns a positive response when the task is added to the internal queue and not when the task is executed.




Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/backupServers/jobs/{jobUid}/assign
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Start Job
Starts a job with the specified UID. Returns a positive response when the task is added to the internal queue and not when the task is executed.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/jobs/{jobUid}/start
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Stop Job
Stops a job with the specified UID. Returns a positive response when the task is added to the internal queue and not when the task is executed.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/jobs/{jobUid}/stop
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Retry Job
Retries a job with the specified UID. Returns a positive response when the retry task is added to the internal queue and not when the task is executed.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/jobs/{jobUid}/retry
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All VM Backup Jobs
Returns a collection resource representation of all backup jobs that protect VMs.




For VM backup jobs targeting Nutanix AHV, HPE Morpheus VM Essentials, Scale Computing HyperCore, Proxmox VE, oVirt KVM, and XCP-ng VMs, the response contains individual worker jobs rather than parent policy jobs.




Request 
query Parameters
expand
Array of strings (BackupServerBackupVmJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupVmJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get VM Backup Job
Returns a resource representation of a backup job with the specified UID that protects VMs.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
expand
Array of strings (BackupServerBackupVmJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupVmJobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "data": {
    },
  • "errors": [
    ]
}
Get VMware vSphere VM Backup Job Configuration
Returns a resource representation of a configuration of a VMware vSphere VM backup job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupVmJobs/vSphere/{jobUid}/configuration
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify VMware vSphere VM Backup Job Configuration
Modifies a configuration of a VMware vSphere VM backup job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/backupServers/jobs/backupVmJobs/vSphere/{jobUid}/configuration
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Create VMware vSphere VM Backup Job
Creates a VMware VSphere VM backup job on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
mappedOrganizationUid
string or null <uuid> 
UID assigned to an organization that is mapped to a backup job on a hosted Veeam Backup & Replication server.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Request Body schema: application/json
required
Job configuration.


name
required
string  [ 1 .. 125 ] characters 
Name of a backup job.


 
description
required
string  <= 2048 characters 
Description of a backup job.


 
isHighPriority
required
boolean
Indicates whether a backup job has a high priority in getting backup resources.


 
required
object (BackupServerBackupJobStorage) 
Backup repository settings.


 
required
object (BackupServerBackupJobVirtualMachines) 
Backup scope.


 
object (BackupServerBackupJobGuestProcessing) 
Guest processing settings.


 
object (BackupServerBackupJobSchedule) 
Job scheduling settings.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/jobs/backupVmJobs/vSphere
Request samples 
application/json
{
  • "instanceUid": "1bcb374f-b346-68b3-bd70-2b40cc7ff6ae",
  • "originalUid": "7fa501dc-f769-4d71-83b1-4f6859c43925",
  • "name": "Backup Job 23",
  • "description": "Customized Job Configuration",
  • "isDisabled": false,
  • "mappedOrganizationUid": "3337e028-55e1-453f-800c-3085a43033c6",
  • "mappedOrganizationName": "hosted",
  • "backupServerUid": "91d5797e-c80b-48e5-bb97-b9df5707f14f",
  • "backupServerName": "vbr1",
  • "isHighPriority": false,
  • "virtualMachines": {
    },
  • "storage": {
    },
  • "guestProcessing": {
    },
  • "schedule": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get VMware Cloud Director VM Backup Job Configuration
Returns a resource representation of a configuration of a VMware Cloud Director VM backup job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupVmJobs/vcd/{jobUid}/configuration
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify VMware Cloud Director VM Backup Job Configuration
Modifies a configuration of a VMware Cloud Director VM backup job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/backupServers/jobs/backupVmJobs/vcd/{jobUid}/configuration
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Create VMware Cloud Director VM Backup Job
Creates a VMware Cloud Director VM backup job on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
mappedOrganizationUid
string or null <uuid> 
UID assigned to an organization that is mapped to a backup job on a hosted Veeam Backup & Replication server.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Request Body schema: application/json
required
Job configuration.


name
required
string  [ 1 .. 125 ] characters 
Name of a backup job.


 
description
required
string  <= 2048 characters 
Description of a backup job.


 
required
object (BackupServerCloudDirectorBackupJobVirtualMachines) 
Backup scope of a VMware Cloud Director backup job.


 
isHighPriority
required
boolean
Indicates whether a backup job has a high priority in getting backup resources.


 
required
object (BackupServerBackupJobStorage) 
Backup repository settings.


 
object (BackupServerCloudDirectorBackupJobGuestProcessing) 
Guest processing settings.


 
object (BackupServerBackupJobSchedule) 
Job scheduling settings.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/jobs/backupVmJobs/vcd
Request samples 
application/json
{
  • "instanceUid": "87ed6896-e968-6379-a9d0-955bce51f2b4",
  • "originalUid": "b7c67df3-4315-46e7-81a0-02e3b642cfb8",
  • "name": "Cloud Director Job 1",
  • "description": "Customized Job Configuration",
  • "isDisabled": false,
  • "mappedOrganizationUid": "b9e5b413-28f2-43c4-a1c7-937f25a4f0b4",
  • "mappedOrganizationName": "hosted",
  • "backupServerUid": "91d5797e-d90b-48e5-bb97-b9df5707f14f",
  • "backupServerName": "vbr1",
  • "isHighPriority": false,
  • "virtualMachines": {
    },
  • "storage": {
    },
  • "guestProcessing": {
    },
  • "schedule": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get All VM Backup Jobs Configured on Backup Server
Returns a collection resource representation of all VM backup jobs configured on a Veeam Backup & Replication server with the specified UID.




For backup jobs targeting Nutanix AHV, HPE Morpheus VM Essentials, Scale Computing HyperCore, Proxmox VE, oVirt KVM, and XCP-ng VMs, the response contains individual worker jobs rather than parent policy jobs.




Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
expand
Array of strings (BackupServerBackupVmJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/backupVmJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of VM Backup Jobs Configured on Backup Server
Returns a collection resource representation of all objects of VM backup jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/backupVmJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of VM Backup Jobs
Returns a collection resource representation of all VM backup job objects.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupVmJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of VM Backup Job
Returns a collection resource representation of all objects of a VM backup job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupVmJobs/{jobUid}/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All VM Replication Jobs
Returns a resource representation of all replication jobs that protects VMs.


Request 
query Parameters
expand
Array of strings (BackupServerReplicationVmJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/replicationVmJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get VM Replication Job
Returns a resource representation of a replication job with the specified UID that protects VMs.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
expand
Array of strings (BackupServerReplicationVmJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/replicationVmJobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "data": {
    },
  • "errors": [
    ]
}
Get All VM Replication Jobs Configured on Backup Server
Returns a collection resource representation of all VM replication jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
expand
Array of strings (BackupServerReplicationVmJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/replicationVmJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of VM Replication Jobs Configured on Backup Server
Returns a collection resource representation of all objects of VM replication jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/replicationVmJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of VM Replication Jobs
Returns a collection resource representation of all VM replication job objects.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/replicationVmJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of VM Replication Job
Returns a collection resource representation of all objects of a VM replication job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/replicationVmJobs/{jobUid}/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All CDP Replication Jobs
Returns a collection resource representation of all CDP replication jobs.


Request 
query Parameters
expand
Array of strings (BackupServerCdpReplicationJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/cdpReplicationJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get CDP Replication Job
Returns a resource representation of a CDP replication job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
expand
Array of strings (BackupServerCdpReplicationJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/cdpReplicationJobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "data": {
    },
  • "errors": [
    ]
}
Get All CDP Replication Jobs Configured on Backup Server
Returns a collection resource representation of all CDP replication jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
expand
Array of strings (BackupServerCdpReplicationJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/cdpReplicationJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of CDP Replication Jobs Configured on Backup Server
Returns a collection resource representation of all objects of CDP replication jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/cdpReplicationJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of CDP Replication Jobs
Returns a collection resource representation of all CDP replication job objects.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/cdpReplicationJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of CDP Replication Job
Returns a collection resource representation of all objects of a CDP replication job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/cdpReplicationJobs/{jobUid}/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Periodic Backup Copy Jobs
Returns a collection resource representation of all periodic backup copy and legacy periodic backup copy jobs.


Request 
query Parameters
expand
Array of strings (BackupServerBackupCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupCopyJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Periodic Backup Copy Job
Returns a resource representation of a periodic backup copy or legacy periodic backup copy job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
expand
Array of strings (BackupServerBackupCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupCopyJobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "data": {
    },
  • "errors": [
    ]
}
Get All Periodic Backup Copy Jobs Configured on Backup Server
Returns a collection resource representation of all periodic backup copy and legacy periodic backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
expand
Array of strings (BackupServerBackupCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/backupCopyJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of Periodic Backup Copy Jobs
Returns a collection resource representation of objects of all periodic backup copy and legacy periodic backup copy jobs.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupCopyJobs/jobObjects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of Periodic Backup Copy Job
Returns a collection resource representation of all objects of a periodic backup copy or legacy periodic backup copy job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupCopyJobs/{jobUid}/jobObjects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of Periodic Backup Copy Jobs Configured on Backup Server
Returns a collection resource representation of objects of all periodic backup copy and legacy periodic backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/backupCopyJobs/jobObjects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All File Share Jobs
Returns a collection resource representation of all file share jobs.


Request 
query Parameters
expand
Array of strings (BackupServerFileShareJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/fileShareJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get File Share Job
Returns a resource representation of a file share job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
expand
Array of strings (BackupServerFileShareJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/fileShareJobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "data": {
    },
  • "errors": [
    ]
}
Get All File Share Jobs Configured on Backup Server
Returns a collection resource representation of all file share jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
expand
Array of strings (BackupServerFileShareJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/fileShareJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of File Share Jobs
Returns a collection resource representation of all file share job objects.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/fileShareJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of File Share Jobs Configured on Backup Server
Returns a collection resource representation of all objects of file share jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/fileShareJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of File Share Job
Returns a collection resource representation of all objects of a file share job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/fileShareJobs/{jobUid}/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All File Share Copy Jobs
Returns a collection resource representation of all backup copy jobs for file shares.


Request 
query Parameters
expand
Array of strings (BackupServerFileShareCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/fileShareCopyJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get File Share Copy Job
Returns a resource representation of a file share backup copy job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
expand
Array of strings (BackupServerFileShareCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/fileShareCopyJobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "data": {
    },
  • "errors": [
    ]
}
Get All File Share Copy Jobs Configured on Backup Server
Returns a collection resource representation of all file share backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
expand
Array of strings (BackupServerFileShareCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/fileShareCopyJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of File Share Copy Jobs
Returns a collection resource representation of all file share backup copy job objects.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/fileShareCopyJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of File Share Copy Jobs Configured on Backup Server
Returns a collection resource representation of all objects of file share backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/fileShareCopyJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of File Share Copy Job
Returns a collection resource representation of all objects of a file share backup copy job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/fileShareCopyJobs/{jobUid}/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Object Storage Backup Jobs
Returns a collection resource representation of all object storage backup jobs.


Request 
query Parameters
expand
Array of strings (BackupServerObjectStorageBackupJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/objectStorageBackupJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Object Storage Backup Job
Returns a resource representation of a object storage backup job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
expand
Array of strings (BackupServerObjectStorageBackupJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/objectStorageBackupJobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "data": {
    },
  • "errors": [
    ]
}
Get All Object Storage Backup Jobs Configured on Backup Server
Returns a collection resource representation of all object storage backup jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
expand
Array of strings (BackupServerObjectStorageBackupJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/objectStorageBackupJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of Object Storage Backup Jobs
Returns a collection resource representation of all object storage backup job objects.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/objectStorageBackupJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of Object Storage Backup Jobs Configured on Backup Server
Returns a collection resource representation of all objects of object storage backup jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/objectStorageBackupJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of Object Storage Backup Job
Returns a collection resource representation of all objects of a object storage backup job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/objectStorageBackupJobs/{jobUid}/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Object Storage Backup Copy Jobs
Returns a collection resource representation of all backup copy jobs for object storage backups.


Request 
query Parameters
expand
Array of strings (BackupServerObjectStorageBackupCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/objectStorageBackupCopyJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Object Storage Backup Copy Job
Returns a resource representation of a object storage backup backup copy job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
expand
Array of strings (BackupServerObjectStorageBackupCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/objectStorageBackupCopyJobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "data": {
    },
  • "errors": [
    ]
}
Get All Object Storage Backup Copy Jobs Configured on Backup Server
Returns a collection resource representation of all object storage backup backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
expand
Array of strings (BackupServerObjectStorageBackupCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/objectStorageBackupCopyJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of Object Storage Backup Copy Jobs
Returns a collection resource representation of all object storage backup backup copy job objects.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/objectStorageBackupCopyJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of Object Storage Backup Copy Jobs Configured on Backup Server
Returns a collection resource representation of all objects of object storage backup backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/objectStorageBackupCopyJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of Object Storage Backup Copy Job
Returns a collection resource representation of all objects of a object storage backup backup copy job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/objectStorageBackupCopyJobs/{jobUid}/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Immediate Backup Copy Jobs
Returns a collection resource representation of all immediate backup copy jobs.


Request 
query Parameters
expand
Array of strings (BackupServerImmediateBackupCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/immediateBackupCopyJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Immediate Backup Copy Job
Returns a resource representation of an immediate backup copy job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
expand
Array of strings (BackupServerImmediateBackupCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/immediateBackupCopyJobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "data": {
    },
  • "errors": [
    ]
}
Get All Immediate Backup Copy Jobs Configured on Backup Server
Returns a collection resource representation of all immediate backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
expand
Array of strings (BackupServerImmediateBackupCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/immediateBackupCopyJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of Immediate Backup Copy Jobs
Returns a collection resource representation of all immediate backup copy job objects.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/immediateBackupCopyJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of Immediate Backup Copy Job
Returns a collection resource representation of all objects of an immediate backup copy job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/immediateBackupCopyJobs/{jobUid}/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of Immediate Backup Copy Jobs Configured on Backup Server
Returns a collection resource representation of all objects of immediate backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/immediateBackupCopyJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All VM Copy Jobs
Returns a collection resource representation of all VM copy jobs.


Request 
query Parameters
expand
Array of strings (BackupServerVmCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/vmCopyJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get VM Copy Job
Returns a resource representation of a VM copy job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
expand
Array of strings (BackupServerVmCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/vmCopyJobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "data": {
    },
  • "errors": [
    ]
}
Get All VM Copy Jobs Configured on Backup Server
Returns a collection resource representation of all VM copy jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
expand
Array of strings (BackupServerVmCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/vmCopyJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All File Copy Jobs
Returns a collection resource representation of all file copy jobs.


Request 
query Parameters
expand
Array of strings (BackupServerFileCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/fileCopyJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get File Copy Job
Returns a resource representation of a file copy job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
expand
Array of strings (BackupServerFileCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/fileCopyJobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "data": {
    },
  • "errors": [
    ]
}
Get All File Copy Jobs Configured on Backup Server
Returns a collection resource representation of all file copy jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
expand
Array of strings (BackupServerFileCopyJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/fileCopyJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All File to Tape Jobs
Returns a collection resource representation of all file to tape jobs.


Request 
query Parameters
expand
Array of strings (BackupServerFileTapeJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/fileTapeJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get File to Tape Job
Returns a resource representation of a file to tape job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
expand
Array of strings (BackupServerFileTapeJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/fileTapeJobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "data": {
    },
  • "errors": [
    ]
}
Get All File to Tape Jobs Configured on Backup Server
Returns a collection resource representation of all file to tape jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
expand
Array of strings (BackupServerFileTapeJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/fileTapeJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of File to Tape Jobs
Returns a collection resource representation of all file to tape job objects.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/fileTapeJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of File to Tape Jobs Configured on Backup Server
Returns a collection resource representation of all objects of file to tape jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/fileTapeJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of File to Tape Job
Returns a collection resource representation of all objects of a file to tape job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/fileTapeJobs/{jobUid}/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Backup to Tape Jobs
Returns a collection resource representation of all backup to tape jobs.


Request 
query Parameters
expand
Array of strings (BackupServerBackupTapeJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupTapeJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Backup to Tape Job
Returns a resource representation of a backup to tape job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
expand
Array of strings (BackupServerBackupTapeJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupTapeJobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "data": {
    },
  • "errors": [
    ]
}
Get All Backup to Tape Jobs Configured on Backup Server
Returns a collection resource representation of all backup to tape jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
expand
Array of strings (BackupServerBackupTapeJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/backupTapeJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Job Objects of Backup to Tape Jobs
Returns a collection resource representation of all jobs processed by backup to tape jobs.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupTapeJobs/jobObjects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Job Objects of Backup to Tape Jobs Configured on Backup Server
Returns 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.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/backupTapeJobs/jobObjects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Job Objects of Backup to Tape Job
Returns a collection resource representation of all jobs processed by a backup to tape job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupTapeJobs/{jobUid}/jobObjects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Repository Objects of Backup to Tape Jobs
Returns a collection resource representation of all repositories processed by backup to tape jobs.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupTapeJobs/repositoryObjects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Repository Objects of Backup to Tape Jobs Configured on Backup Server
Returns 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.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/backupTapeJobs/repositoryObjects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Repository Objects of Backup to Tape Job
Returns a collection resource representation of all repositories processed by a backup to tape job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/backupTapeJobs/{jobUid}/repositoryObjects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Backup Agent Jobs
Returns a collection resource representation of all backup agent jobs.


Request 
query Parameters
expand
Array of strings (BackupServerAgentJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/agentJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Backup Agent Jobs Configured on Backup Server
Returns a collection resource representation of all backup agent jobs configured on a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
expand
Array of strings (BackupServerAgentJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/jobs/agentJobs
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Backup Agent Job
Returns a resource representation of a backup agent job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Job UID.


 
query Parameters
expand
Array of strings (BackupServerAgentJobExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "BackupServerJob"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/agentJobs/{jobUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get All Objects of Backup Agent Job
Returns a collection resource representation of all objects of a backup agent job with the specified UID.


Request 
path Parameters
jobUid
required
string <uuid> 
Backup agent job UID.


 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/agentJobs/{jobUid}/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Objects of Backup Agent Jobs
Returns a collection resource representation of all backup agent job objects.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/jobs/agentJobs/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}