Veeam Service Provider Console 9.1
REST API Reference
Related documents

Deployment

This resource collection represents deployment tasks.

Install Backup Agent on Discovered Computer

Deploys Veeam backup agent and management agent on a discovered computer with the specified UID. Deploys only the missing component if the other one is already installed.

To track the deployment progress, you can use the WaitDeploymentTask operation.

Request
path Parameters
computerUid
required
string <uuid>

Computer 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.6.1
Request Body schema: application/json
required

Deployment configuration.

backupPolicyUid
string or null <uuid>

UID of a backup policy that must be assigned to Veeam backup agent.

allowAutoRebootIfNeeded
boolean
Default: false

Indicates whether system reboot is allowed.

setReadOnlyAccess
boolean
Default: true

Indicates whether the read-only access mode is enabled for Veeam backup agents.

installCbtDriver
boolean
Default: false

Indicates whether CBT driver is installed during agent deployment.

object or null

Credentials required to access discovered computers.

object or null

Veeam backup agent global settings.

Responses
200

Deployment task UID.

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) are returned with the 520 HTTP status code. For details, see the response body.

post/discovery/computers/{computerUid}/installBackupAgent
Request samples
application/json
{
  • "backupPolicyUid": "70069387-2799-489b-9592-4b11c55012d7",
  • "allowAutoRebootIfNeeded": true,
  • "setReadOnlyAccess": true,
  • "installCbtDriver": false,
  • "credentials": null,
  • "backupAgentSettings": null
}
Response samples
application/json
{
  • "data": "e7b6ecfd-c87c-46e4-89f1-cc1bba09bede"
}

Install Backup Agent on Discovered Linux Computer

Deploy Veeam backup agent and management agent on a discovered Linux computer with the specified UID. Deploys only the missing component if the other one is already installed.

To track the deployment progress, you can use the WaitDeploymentTask operation.

Request
path Parameters
computerUid
required
string <uuid>

Computer 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.6.1
Request Body schema: application/json
required
backupPolicyUid
string or null <uuid>

UID of a backup policy that is assigned to Veeam Agent for Linux.

setReadOnlyAccess
boolean
Default: true

Indicates whether the read-only access mode is enabled for Veeam Agent for Linux.

Array of objects or null (LinuxDiscoveryCredentials)

Credentials required to access discovered computers.

Responses
200

Deployment task UID.

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) are returned with the 520 HTTP status code. For details, see the response body.

post/discovery/computers/{computerUid}/installLinuxBackupAgent
Request samples
application/json
{
  • "backupPolicyUid": null,
  • "setReadOnlyAccess": true,
  • "credentials": null
}
Response samples
application/json
{
  • "data": "b6293d84-cbb0-4ab1-a222-453fe60c07ef"
}

Install Veeam Backup & Replication on Discovered Computer

Installs Veeam Backup & Replication and management agent on a discovered computer with the specified UID.

Deploys only the missing component if the other one is already installed. To track the deployment progress, you can use the WaitDeploymentTask operation.

Request
path Parameters
computerUid
required
string <uuid>

Discovered computer 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.6.1
Request Body schema: application/json
required

Deployment configuration.

required
object

Deployment configuration.

required
object

License settings.

object or null

Credentials required to access the target server. Credentials are optional if the service provider management agent is installed on the server.

Responses
200

Deployment task UID.

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) are returned with the 520 HTTP status code. For details, see the response body.

post/discovery/computers/{computerUid}/installBackupServer
Request samples
application/json
{
  • "configuration": {
    },
  • "licenseSettings": {
    },
  • "credentials": {
    }
}
Response samples
application/json
{
  • "data": "ae61e533-82c7-4cb6-a030-78ae589cf49d"
}

Schedule Veeam Backup & Replication Installation on Discovered Computer

Creates a sheduled task that installs Veeam Backup & Replication and management agent on a discovered computer with the specified UID.

Deploys only the missing component if the other one is already installed.

Request
path Parameters
computerUid
required
string <uuid>

Discovered computer 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.6.1
Request Body schema: application/json
required

Deployment configuration.

required
object

Deployment configuration.

required
object

Deployment scheduling settings.

Responses
200

Resource representation of a scheduled task.

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) are returned with the 520 HTTP status code. For details, see the response body.

post/discovery/computers/{computerUid}/scheduledTasks/installBackupServer
Request samples
application/json
{
  • "configuration": {
    },
  • "schedule": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Install Veeam ONE on Discovered Computer

Installs Veeam ONE and management agent on a discovered computer with the specified UID.

Deploys only the missing component if the other one is already installed. To track the deployment progress, you can use the WaitDeploymentTask operation.

Request
path Parameters
computerUid
required
string <uuid>

Discovered computer 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.6.1
Request Body schema: application/json
required

Deployment configuration.

required
object

Deployment configuration.

If the distribution and usePredownloadedIso properties have the null value, the most recent version of Veeam ONE will be downloaded automatically.

required
object

License settings.

Responses
200

Deployment task UID.

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) are returned with the 520 HTTP status code. For details, see the response body.

post/discovery/computers/{computerUid}/installVOneServer
Request samples
application/json
{
  • "configuration": {
    },
  • "licenseSettings": {
    }
}
Response samples
application/json
{
  • "data": "ae61e533-82c7-4cb6-a030-78ae589cf49d"
}

Schedule Veeam ONE Installation on Discovered Computer

Creates a sheduled task that installs Veeam ONE and management agent on a discovered computer with the specified UID.

Deploys only the missing component if the other one is already installed.

Request
path Parameters
computerUid
required
string <uuid>

Discovered computer 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.6.1
Request Body schema: application/json
required

Deployment configuration.

required
object

Deployment configuration.

required
object

Deployment scheduling settings.

Responses
200

Resource representation of a scheduled task.

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) are returned with the 520 HTTP status code. For details, see the response body.

post/discovery/computers/{computerUid}/scheduledTasks/installVOneServer
Request samples
application/json
{
  • "configuration": {
    },
  • "schedule": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Get All Deployment Tasks Scheduled for Computer

Returns a collection resource representation of all deployment tasks scheduled for a computer with the specified UID.

Request
path Parameters
computerUid
required
string <uuid>

Computer 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.

get/discovery/computers/{computerUid}/scheduledDeploymentTasks
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Deployment Tasks Scheduled for Management Agent
Returns a collection resource representation of all deployment tasks scheduled for a management agent with the specified UID.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/managementAgents/{managementAgentUid}/scheduledDeploymentTasks
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Computer Scheduled Deployment Task
Returns a resource representation of a computer scheduled deployment task with the specified UID.


Request 
path Parameters
computerUid
required
string <uuid> 
Computer UID.


 
taskUid
required
string <uuid> 
Deployment task 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


get/discovery/computers/{computerUid}/scheduledDeploymentTasks/{taskUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Computer Scheduled Deployment Task
Modifies a computer scheduled deployment task with the specified UID.


Request 
path Parameters
computerUid
required
string <uuid> 
Computer UID.


 
taskUid
required
string <uuid> 
Deployment task 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


patch/discovery/computers/{computerUid}/scheduledDeploymentTasks/{taskUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Computer Scheduled Deployment Task
Deletes a computer scheduled deployment task with the specified UID.


Request 
path Parameters
computerUid
required
string <uuid> 
Computer UID.


 
taskUid
required
string <uuid> 
Deployment task 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


delete/discovery/computers/{computerUid}/scheduledDeploymentTasks/{taskUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Management Agent Scheduled Deployment Task
Returns a resource representation of a management agent scheduled deployment task with the specified UID.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent UID.


 
taskUid
required
string <uuid> 
Deployment task 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/managementAgents/{managementAgentUid}/scheduledDeploymentTasks/{taskUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Management Agent Scheduled Deployment Task
Modifies a management agent scheduled deployment task with the specified UID.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent UID.


 
taskUid
required
string <uuid> 
Deployment task 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/managementAgents/{managementAgentUid}/scheduledDeploymentTasks/{taskUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Management Agent Scheduled Deployment Task
Deletes a management agent scheduled deployment task with the specified UID.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent UID.


 
taskUid
required
string <uuid> 
Deployment task 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/managementAgents/{managementAgentUid}/scheduledDeploymentTasks/{taskUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Start Computer Scheduled Deployment Task
Starts a computer scheduled deployment task with the specified UID.


Request 
path Parameters
computerUid
required
string <uuid> 
Computer UID.


 
taskUid
required
string <uuid> 
Scheduled task 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.6.1
Responses 
200
Deployment task UID.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/discovery/computers/{computerUid}/scheduledDeploymentTasks/{taskUid}/start
Request samples 
Response samples 
application/json
{
  • "data": "cfce7c6e-3cea-4fe6-bf5b-6cdd6951ae75"
}
Start Management Agent Scheduled Deployment Task
Starts a management agent scheduled deployment task with the specified UID.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent UID.


 
taskUid
required
string <uuid> 
Scheduled task 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.6.1
Responses 
200
Deployment task UID.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/managementAgents/{managementAgentUid}/scheduledDeploymentTasks/{taskUid}/start
Request samples 
Response samples 
application/json
{
  • "data": "733ccd0c-f40e-4348-96de-ed9a120c2667"
}
Update Veeam Backup & Replication on Server
Installs the latest update of Veeam Backup & Replication on a server with the specified UID.




To track the installation progress, you can use the WaitDeploymentTask operation.       




Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server 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.6.1
Request Body schema: application/json
required
Deployment configuration.


answerXml
required
string
XML string containing installation parameters.




To obtain a template of XML string, perform the GetBackupServerDeploymentConfigurationXml operation.




 
object or null
Path to the Veeam Backup & Replication setup file.


 
usePredownloadedIso
boolean or null
Indicates whether the predownloaded Veeam Backup & Replication setup file is used for installation.




Provided value has higher priority than the distribution property value.




 
allowAutoReboot
boolean or null
Indicates whether a server must be automatically rebooted after the installation is complete.


 
stopAllActivities
boolean or null
Indicates whether all other tasks must be stopped during installation. Can be enabled only for update installation.


 
useManagementAgentCredentials
boolean or null
Indicates whether management agent credentials must be used as service account credentials.




Provided value has higher priority than the adminCredentials property value.




 
object or null
Service account credentials.


 
Responses 
200
Deployment task UID.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/upgrade
Request samples 
application/json
{
  • "distribution": {
    },
  • "usePredownloadedIso": false,
  • "answerXml": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<unattendedInstallationConfiguration bundle=\"VBR\" mode=\"upgrade\">\n  <properties>\n\n    <!--License agreements-->\n    <property name=\"ACCEPT_EULA\" value=\"1\" />\n    <property name=\"ACCEPT_LICENSING_POLICY\" value=\"1\" />\n    <property name=\"ACCEPT_THIRDPARTY_LICENSES\" value=\"1\" />\n    <property name=\"ACCEPT_REQUIRED_SOFTWARE\" value=\"1\" />\n\n    <!--License file-->\n    <!--property name=\"VBR_LICENSE_FILE\" value=\"\" /-->\n    <property name=\"VBR_LICENSE_AUTOUPDATE\" value=\"1\" />\n\n    <!--Service account-->\n    <!--property name=\"VBR_SERVICE_PASSWORD\" value=\"\" hidden=\"1\"/-->\n\n    <!--Database configuration-->\n    <property name=\"VBR_SQLSERVER_PASSWORD\" value=\"Password1\" hidden=\"1\"/>\n\n    <!--Automatic update settings-->\n    <property name=\"VBR_AUTO_UPGRADE\" value=\"1\" />\n\n  </properties>\n</unattendedInstallationConfiguration>\n",
  • "allowAutoReboot": true,
  • "stopAllActivities": true,
  • "useManagementAgentCredentials": false,
  • "adminCredentials": {
    }
}
Response samples 
application/json
{
  • "data": "ae61e533-82c7-4cb6-a030-78ae589cf49d"
}
Patch Veeam Backup & Replication on Server
Patches Veeam Backup & Replication on a server with the specified UID.




To track the deployment progress, you can use the WaitDeploymentTask operation.       




Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server 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.6.1
Request Body schema: application/json
required
Patch configuration.


allowAutoReboot
boolean or null
Indicates whether a server must be automatically rebooted after the installation is complete.


 
stopAllActivities
boolean or null
Indicates whether all other tasks must be stopped during installation.


 
Responses 
200
Deployment task UID.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/patch
Request samples 
application/json
{
  • "allowAutoReboot": true,
  • "stopAllActivities": true
}
Response samples 
application/json
{
  • "data": "af483eb8-10ae-4482-a18a-4b5746ab5340"
}
Schedule Veeam Backup & Replication Update
Creates a scheduled task that installs the latest Veeam Backup & Replication update on a server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server 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.6.1
Request Body schema: application/json
required
Deployment configuration.


required
object
Deployment configuration.


 
required
object
Deployment scheduling settings.


 
Responses 
200
Resource representation of a scheduled task.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/scheduledTasks/upgrade
Request samples 
application/json
{
  • "configuration": {
    },
  • "schedule": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Schedule Veeam Backup & Replication Patch
Creates a scheduled task that installes Veeam Backup & Replication patch on a server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server 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.6.1
Request Body schema: application/json
required
Patch configuration.


required
object
Patch deployment configuration.


 
required
object
Patch deployment schedule settings.


 
Responses 
200
Resource representation of a scheduled task.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/scheduledTasks/patch
Request samples 
application/json
{
  • "configuration": {
    },
  • "schedule": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Update Veeam Agent for Microsoft Windows
Updates Veeam Agent for Microsoft Windows with the specified UID. 




To track the deployment progress, you can use the WaitDeploymentTask operation.




Request 
path Parameters
backupAgentUid
required
string <uuid> 
Veeam Agent for Microsoft Windows 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupAgents/windows/{backupAgentUid}/update
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Update Veeam Agent for Linux
Updates a Veeam Agent for Linux with the specified UID.




To track the deployment progress, you can use the WaitDeploymentTask operation.




Request 
path Parameters
backupAgentUid
required
string <uuid> 
Veeam Agent for Linux 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupAgents/linux/{backupAgentUid}/update
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Update Veeam Agent for Mac
Updates a Veeam Agent for Mac with the specified UID.




To track the deployment progress, you can use the WaitDeploymentTask operation.




Request 
path Parameters
backupAgentUid
required
string <uuid> 
Veeam Agent for Mac 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupAgents/mac/{backupAgentUid}/update
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get All Deployment Tasks
Returns a collection resource representation of all deployment tasks.


Request 
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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


get/deployment/deploy
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Deployment Task
Returns a resource representation of a deployment task with the specified UID.


Request 
path Parameters
deploymentTaskUid
required
string <uuid> 
Deployment task 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


get/deployment/deploy/{deploymentTaskUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Run Waiting Task for Deployment Task
Initiates an async action that waits for a deployment task with the specified UID to complete.


Request 
path Parameters
deploymentTaskUid
required
string <uuid> 
Deployment task 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


post/deployment/deploy/{deploymentTaskUid}/wait
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Deployment Task Status
Returns a resource representation of deployment task status.


Request 
path Parameters
deploymentTaskUid
required
string <uuid> 
Deployment task UID.


 
managementAgentUid
required
string <uuid> 
Management agent 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


get/deployment/deploy/{deploymentTaskUid}/log/{managementAgentUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get Example for Veeam Backup & Replication Server Deployment Configuration
Returns a resource representation of an example for Veeam Backup & Replication server deployment configuration in the XML format.




Error response is returned in the JSON format.




Request 
query Parameters
backupServerDeploymentType
required
string
Deployment type.


 Enum: "installation" "upgrade"  
managementAgentUid
string or null <uuid> 
UID assigned to a management agent installed on a server on which Veeam Backup & Replication must be deployed. 




If Veeam Backup & Replication is already installed on the server, Veeam Service Provider Console will automatically provide a configuration file suitable for the installed version.
If Veeam Backup & Replication is not installed, Veeam Service Provider Console will provide a configuration file suitable for the latest Veeam Backup & Replication version.




 
escapeCharacters
boolean
 Default:  false
Defines whether escape characters are enabled.


 
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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


get/deployment/deploy/backupServers/configuration/xml
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
Get Management Agent Deployment Parameters for Hosted Linux Computers
Returns a resource representation of parameters for management agent deployment on hosted Linux computers.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent 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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/managementAgents/{managementAgentUid}/hosted/linux
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Update Veeam ONE on Server
Installs the latest Veeam ONE update on a server with the specified UID.




To track the installation progress, you can use the WaitDeploymentTask operation.       




Request 
path Parameters
vOneServerUid
required
string <uuid> 
Veeam ONE server 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.6.1
Request Body schema: application/json
required
Deployment configuration.


answerXml
required
string
XML string containing installation parameters.


 
object or null
Path to the Veeam ONE setup file.


 
usePredownloadedIso
boolean or null
Indicates whether the predownloaded Veeam ONE setup file is used for installation.




Provided value has higher priority than the distribution property value.




 
allowAutoReboot
boolean or null
Indicates whether a server must be automatically rebooted after the installation is complete.


 
stopAllActivities
boolean or null
Indicates whether all other tasks must be stopped during installation. Can be enabled only for update installation.


 
useManagementAgentCredentials
boolean or null
Indicates whether management agent credentials must be used as service account credentials.




Provided value has higher priority than the adminCredentials property value.




 
object or null
Service account credentials.


 
Responses 
200
Deployment task UID.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/voneServers/{vOneServerUid}/upgrade
Request samples 
application/json
{
  • "distribution": {
    },
  • "usePredownloadedIso": null,
  • "answerXml": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<unattendedInstallationConfiguration bundle=\"Vo\" mode=\"upgrade\" version=\"1.0\">\n  <properties>\n\n    <!--License agreements-->\n    <property name=\"ACCEPT_EULA\" value=\"1\" />\n    <property name=\"ACCEPT_LICENSING_POLICY\" value=\"1\" />\n    <property name=\"ACCEPT_THIRDPARTY_LICENSES\" value=\"1\" />\n    <property name=\"ACCEPT_REQUIRED_SOFTWARE\" value=\"1\" />\n\n    <!--License file-->\n    <property name=\"VO_LICENSE_FILE\" value=\"\" />\n    <property name=\"VO_LICENSE_AUTOUPDATE\" value=\"1\" />\n\n    <!--Service account-->\n    <property name=\"VO_SERVICE_USER\" value=\"vspc\\administrator\" />\n    <property name=\"VO_SERVICE_PASSWORD\" value=\"Password1\" hidden=\"1\" />\n\n    <!--Database configuration-->\n    <property name=\"VO_SQLSERVER_USERNAME\" value=\"\" />\n    <property name=\"VO_SQLSERVER_PASSWORD\" value=\"\" hidden=\"1\"/>\n\n    <!--Ports configuration-->\n    <property name=\"VO_MONITORING_SERVICE_PORT\" value=\"2714\" />\n    <property name=\"VO_REPORTING_SERVICE_PORT\" value=\"2742\" />\n    <property name=\"VO_INTERNAL_WEB_API_PORT\" value=\"2741\"  />\n    <!--Certificate configuration-->\n    <property name=\"VO_CERTIFICATE_THUMBPRINT\" value=\"\" />\n\n    <!--Server connection-->\n    <property name=\"VO_CONNECTION_SERVER_NAME\" value=\"\" />\n    <property name=\"VO_CONNECTION_WEB_API_PORT\" value=\"\" />\n    <property name=\"VO_CONNECTION_USER\" value=\"\" />\n    <property name=\"VO_CONNECTION_PASSWORD\" value=\"\" hidden=\"1\" />\n\n",
  • "allowAutoReboot": true,
  • "stopAllActivities": null,
  • "useManagementAgentCredentials": null,
  • "adminCredentials": {
    }
}
Response samples 
application/json
{
  • "data": "b68fbe4d-9886-430a-8389-fc01da7b081b"
}
Get Example for Veeam ONE Server Deployment Configuration
Returns a resource representation of an example for Veeam ONE server deployment configuration in the XML format.




Error response is returned in the JSON format.




Request 
query Parameters
voneServerDeploymentType
required
string
Deployment type.


 Enum: "installation" "upgrade"  
managementAgentUid
string or null <uuid> 
UID assigned to a management agent installed on a server on which Veeam ONE must be deployed. 




If Veeam ONE is already installed on the server, Veeam Service Provider Console will automatically provide a configuration file suitable for the installed version.
If Veeam ONE is not installed, Veeam Service Provider Console will provide a configuration file suitable for the latest Veeam ONE version.




 
escapeCharacters
boolean
 Default:  false
Defines whether escape characters are enabled.


 
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.6.1
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) are returned with the 520 HTTP status code. For details, see the response body.


get/deployment/deploy/voneServers/configuration/xml
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
Schedule Veeam ONE Update
Creates a scheduled task that installs the latest Veeam ONE update on a server with the specified UID.


Request 
path Parameters
vOneServerUid
required
string <uuid> 
Veeam ONE server 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.6.1
Request Body schema: application/json
required
Deployment configuration.


required
object
Deployment configuration.




If the distribution and usePredownloadedIso properties have the null value, the most recent version of Veeam ONE will be downloaded automatically.




 
required
object
Deployment scheduling settings.


 
Responses 
200
Resource representation of a scheduled task.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/voneServers/{vOneServerUid}/scheduledTasks/upgrade
Request samples 
application/json
{
  • "configuration": {
    },
  • "schedule": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}

    
    

                                

                                    
Document updated 11/06/2025
Page content applies to build 9.1.0.30345