Veeam Backup & Replication 13
REST API Reference
Related documents

Managed Servers

The Managed Servers section defines operations for managing servers.

NOTE
In this version, the REST API supports the following server types: VMware vSphere, Hyper-V, Linux and Windows.

Get All Servers

The HTTP GET request to the /api/v1/backupInfrastructure/managedServers endpoint gets an array of all servers that are added to the backup infrastructure.

Available to: Backup Administrator, Backup Operator, Restore Operator, Backup Viewer. Also available to custom roles that have backup or restore permissions.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of servers to skip.

limit
integer <int32>
Default: 200

Maximum number of servers to return.

orderColumn
string (EManagedServersFiltersOrderColumn)

Sorts servers by one of the server parameters.

Enum: "Name" "Type" "Description" "Status"
orderAsc
boolean

If true, sorts servers in ascending order by the orderColumn parameter.

nameFilter
string

Filters servers by the nameFilter pattern. The pattern can match any server parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.

typeFilter
Array of strings (EManagedServerType)

Filters servers by server type.

Items Enum: "WindowsHost" "LinuxHost" "ViHost" "CloudDirectorHost" "HvServer" "HvCluster" "SCVMM" "SmbV3Cluster" "SmbV3StandaloneHost" "NutanixCluster" "PrismCentral" "ProxmoxNode" "ProxmoxCluster"
viTypeFilter
string (EViHostType)

Filters servers by the type of VMware vSphere server.

Enum: "ESX" "ESXi" "VC"
serverStateFilter
string (EManagedServerState)

Filters servers by their state.

Enum: "Available" "Unavailable" "Any"
updatesStateFilter
Array of strings (EHostUpdatesState)

Filters servers by updatesState (only for Linux hosts).

Items Enum: "CheckInProgress" "Installing" "LastInstallFailed" "Available" "NotAvailable" "CheckUpdatesFailed" "OutOfDate"
includeNestedHosts
boolean

If true, nested hosts will be included in the selection.

skipDedupAppliances
boolean
Default: false

If true, excludes Linux-based deduplication storage appliance hosts (such as ExaGrid, Quantum, Infinidat, Fujitsu) from the list. Use this filter when building a server picker for roles that cannot run on a storage appliance (for example, a General-Purpose Backup proxy).

header Parameters
x-api-version
required
string
Default: 1.3-rev2

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Responses
200

OK

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v1/backupInfrastructure/managedServers
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Server
The HTTP POST request to the /api/v1/backupInfrastructure/managedServers endpoint adds a server to the backup infrastructure. 
If you want to add a Microsoft Hyper-V cluster and include only specific Microsoft Hyper-V hosts, follow these steps:
 
  1. Add the credentials used to connect to the Microsoft Hyper-V cluster: Add Credentials Record. You will need to specify the credentials ID in the following requests.
    2.  
  2. Discover the hosts managed by the cluster: Get Microsoft Hyper-V Servers Managed by Microsoft Hyper-V Cluster or SCVMM Server.
    3.  
  3. Add the Microsoft Hyper-V cluster using this request. In the request body, specify the necessary hosts.
 
If you want to add an SCVMM server and include only specific Microsoft Hyper-V hosts, follow these steps:
 
  1. Add the credentials used to connect to the SCVMM server: Add Credentials Record. You will need to specify the credentials ID in the following requests.
    2.  
  2. To add an SCVMM server without hosts, use this request and set addAllServers to false in the request body .
    3.  
  3. Discover the hosts managed by the SCVMM server: Get Microsoft Hyper-V Servers Managed by Microsoft Hyper-V Cluster or SCVMM Server.
    4.  
  4. To add the necessary hosts, edit the SCVMM server: Edit Server.
    5.  
 
Available to: Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
description
required
string
Description of the server.


 
name
required
string
Full DNS name or IP address of the server.


 
type
required
string (EManagedServerType) 
Type of the server.


 
credentialsStorageType
required
string (ECredentialsStorageType) 
Credentials type used to connect to the server.


 Enum: "Permanent" "SingleUse" "Certificate"  
credentialsId
string <uuid> 
ID of the credentials used to connect to the server.


 
object (ManagedHostPortsModel) 
Veeam Backup & Replication components installed on the server and ports used by the components.


 
Responses 
201
An Infrastructure session has been created to add the server. To check the progress, track the session state.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/backupInfrastructure/managedServers
Request samples 
application/json
{
  • "networkSettings": {
    },
  • "type": "WindowsHost",
  • "name": "enterprise01.tech.local",
  • "description": "Backup Repository",
  • "credentialsId": "d7af15f3-8808-454e-ba79-2c2267acb05d",
  • "credentialsStorageType": "Permanent"
}
Response samples 
application/json
{
  • "sessionType": "Infrastructure",
  • "state": "Working",
  • "id": "89fe3413-cde0-4061-925a-6d72857db45c",
  • "name": "Infrastructure Item Saving",
  • "jobId": "89fe3413-cde0-4061-925a-6d72857db45c",
  • "creationTime": "2025-07-30T13:01:27.491999+02:00",
  • "progressPercent": 0,
  • "result": {
    },
  • "usn": 331548,
  • "initiatedBy": ".\\veeam-rest-service"
}
Get vCenter Servers Attached to Cloud Director Server
The HTTP POST request to the /api/v1/backupInfrastructure/managedServers/cloudDirectorHosts endpoint gets an array of vCenter Servers attached to a specific VMware Cloud Director server.
 Available to: Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
credentialsId
required
string <uuid> 
ID of the credentials used to connect to the server.


 
url
required
string
URL of the VMware Cloud Director server.


 
certificateThumbprint
string
Certificate thumbprint used to verify the server identity. For details on how to get the thumbprint, see Request TLS Certificate or SSH Fingerprint.


 
Responses 
200
OK


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/backupInfrastructure/managedServers/cloudDirectorHosts
Request samples 
application/json
{}
Response samples 
application/json
{
  • "data": [
    ]
}
Get Microsoft Hyper-V Servers Managed by Microsoft Hyper-V Cluster or SCVMM Server
The HTTP POST request to the /api/v1/backupInfrastructure/managedServers/hyperVHosts endpoint gets an array of Microsoft Hyper-V Servers managed by a specific Microsoft Hyper-V cluster or an SCVMM server. 
Before you discover the hosts of your SCVMM server, you must add the SCVMM server to the Veeam Backup & Replication infrastructure.
 Available to: Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
credentialsId
string <uuid> 
Credentials ID used to connect to the Microsoft Hyper-V cluster or SCVMM Server.


 
scvmmHostId
string <uuid> 
ID of the SCVMM server.


 
hvClusterName
string
Name of the Microsoft Hyper-V cluster.


 
Responses 
200
OK


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/backupInfrastructure/managedServers/hyperVHosts
Request samples 
application/json
{
  • "credentialsId": "8f2e6fa5-4757-4312-a4b2-73b9325df6a4",
  • "hvClusterName": "twhv19cluster.tech.local"
}
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Server
The HTTP GET request to the /api/v1/backupInfrastructure/managedServers/{id} endpoint gets a managed server that has the specified id.
Available to: Backup Administrator, Backup Operator, Restore Operator, Backup Viewer. Also available to custom roles that have backup or restore permissions.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Managed server ID. To get the ID, run the Get All Servers request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/backupInfrastructure/managedServers/{id}
Request samples 
Response samples 
application/json
{
  • "credentialsStorageType": "Permanent",
  • "credentialsId": "ccddfca4-571d-4d1e-9609-f709d219326b",
  • "networkSettings": {
    },
  • "maxTaskCount": 4,
  • "type": "HvServer",
  • "status": "Available",
  • "id": "8a689010-07a6-4b3c-9a26-786c8fad2e70",
  • "name": "pdctwhv02.tech.local",
  • "description": "Microsof Hyper-V host created by .\\veeamadmin"
}
Edit Server
The HTTP PUT request to the /api/v1/backupInfrastructure/managedServers/{id} endpoint edits a managed server that has the specified id.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Managed server ID. To get the ID, run the Get All Servers request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
description
required
string
Description of the server.


 
id
required
string <uuid> 
ID of the server.


 
name
required
string
Full DNS name or IP address of the server.


 
type
required
string (EManagedServerType) 
Type of the server.


 
status
required
string (EManagedServersStatus) 
Availability status.


 Enum: "Available" "Unavailable"  
credentialsStorageType
required
string (ECredentialsStorageType) 
Credentials type used to connect to the server.


 Enum: "Permanent" "SingleUse" "Certificate"  
credentialsId
string <uuid> 
ID of the credentials used to connect to the server.


 
object (ManagedHostPortsModel) 
Veeam Backup & Replication components installed on the server and ports used by the components.


 
isBackupServer
boolean
If true, the Microsoft Windows server is a backup server.


 
isDefaultMountServer
boolean
If true, the server is the default mount server for Microsoft Windows machines.


 
updatesState
string (EHostUpdatesState) 
Host updates state.


 Enum: "CheckInProgress" "Installing" "LastInstallFailed" "Available" "NotAvailable" "CheckUpdatesFailed" "OutOfDate"  
Responses 
201
An Infrastructure session has been created to edit the server. To check the progress, track the session state.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


put/api/v1/backupInfrastructure/managedServers/{id}
Request samples 
application/json
{
  • "credentialsStorageType": "Permanent",
  • "credentialsId": "ccddfca4-571d-4d1e-9609-f709d219326b",
  • "networkSettings": {
    },
  • "maxTaskCount": 4,
  • "type": "HvServer",
  • "status": "Available",
  • "id": "8a689010-07a6-4b3c-9a26-786c8fad2e70",
  • "name": "pdctwhv02.tech.local",
  • "description": "Microsof Hyper-V host created by .\\veeamadmin"
}
Response samples 
application/json
{
  • "sessionType": "Infrastructure",
  • "state": "Working",
  • "id": "89fe3413-cde0-4061-925a-6d72857db45c",
  • "name": "Infrastructure Item Saving",
  • "jobId": "89fe3413-cde0-4061-925a-6d72857db45c",
  • "creationTime": "2025-07-30T13:01:27.491999+02:00",
  • "progressPercent": 0,
  • "result": {
    },
  • "usn": 331548,
  • "initiatedBy": ".\\veeam-rest-service"
}
Remove Server
The HTTP DELETE request to the /api/v1/backupInfrastructure/managedServers/{id} endpoint removes a managed server that has the specified id from the backup infrastructure.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Managed server ID. To get the ID, run the Get All Servers request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
201
An InfrastructureItemDeletion session has been created to remove the server. To check the progress, track the session state.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


delete/api/v1/backupInfrastructure/managedServers/{id}
Request samples 
Response samples 
application/json
{
  • "sessionType": "InfrastructureItemDeletion",
  • "state": "Stopped",
  • "id": "af1a6027-3845-487e-9a16-6849f4775a1e",
  • "name": "Infrastructure Item Deletion",
  • "jobId": "fc5683a4-8c25-4f8e-97cc-0a40745a5729",
  • "creationTime": "2025-06-28T21:21:08.81+02:00",
  • "endTime": "2025-06-28T21:22:15.92+02:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "resourceId": "af1a6027-3845-487e-9a16-6849f4775a1e",
  • "usn": 0
}
Change to Single-Use Credentials
The HTTP POST request to the /api/v1/backupInfrastructure/managedServers/{id}/updateSingleUseCredentials endpoint changes the credentials type (from persistent to single-use credentials) for a Linux server that has the specified id. Single-use type of credentials is required if you want to use the Linux server as a hardened repository.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Managed server ID. To get the ID, run the Get All Servers request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
username
required
string
User name.


 
type
required
string (ECredentialsType) 
Credentials type.


 
password
required
string
Password.


 
description
string
Description of the credentials record.


 
uniqueId
string
Unique ID that identifies the credentials record.


 
Responses 
201
An Infrastructure session has been created to edit the server. To check the progress, track the session state.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/backupInfrastructure/managedServers/{id}/updateSingleUseCredentials
Request samples 
application/json
{
  • "username": "root",
  • "description": "Single-use Linux credentials",
  • "type": "Linux",
  • "SSHPort": 22,
  • "elevateToRoot": true,
  • "addToSudoers": false,
  • "useSu": false,
  • "authenticationType": "Password",
  • "password": "Str0ngP@ssw0rd"
}
Response samples 
application/json
{
  • "sessionType": "Infrastructure",
  • "state": "Working",
  • "id": "89fe3413-cde0-4061-925a-6d72857db45c",
  • "name": "Infrastructure Item Saving",
  • "jobId": "89fe3413-cde0-4061-925a-6d72857db45c",
  • "creationTime": "2025-07-30T13:01:27.491999+02:00",
  • "progressPercent": 0,
  • "result": {
    },
  • "usn": 331548,
  • "initiatedBy": ".\\veeam-rest-service"
}
Get Volumes for Microsoft Hyper-V Standalone Server
The HTTP GET request to the /api/v1/backupInfrastructure/managedServers/{id}/volumes endpoint gets volumes on a managed server that has the specified id. Applicable only for Microsoft Hyper-V standalone server
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Managed server ID. To get the ID, run the Get All Servers request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/backupInfrastructure/managedServers/{id}/volumes
Request samples 
Response samples 
application/json
{
  • "volumes": [
    ],
  • "changedBlockTracking": true,
  • "failoverToVSSProvider": false
}
Edit Volumes on Microsoft Hyper-V Standalone Server
The HTTP PUT request to the /api/v1/backupInfrastructure/managedServers/{id}/volumes endpoint edits particular volumes. 
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Managed server ID. To get the ID, run the Get All Servers request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
changedBlockTracking
required
boolean
 Default:  false
If true, CBT is enabled for this host.


 
failoverToVSSProvider
required
boolean
 Default:  true
If true, Veeam Backup & Replication uses the specified hardware VSS provider for volume snapshot creation.


 
required
Array of objects (HyperVVolumeObjectModel) 
Array of volumes.


 
Responses 
200
Volumes have been updated.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


put/api/v1/backupInfrastructure/managedServers/{id}/volumes
Request samples 
application/json
{
  • "volumes": [
    ],
  • "changedBlockTracking": true,
  • "failoverToVSSProvider": false
}
Response samples 
application/json
{
  • "volumes": [
    ],
  • "changedBlockTracking": true,
  • "failoverToVSSProvider": false
}
Rescan All Managed Servers
The HTTP POST request to the /api/v1/backupInfrastructure/managedServers/rescan endpoint rescans all or specified managed servers. 
Available to: Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
ids
Array of strings <uuid> 
Array of IDs of managed servers that must be rescanned. To get the IDs, run the Get All Servers request.


 
Responses 
201
A VolumesDiscover session has been created to rescan all managed servers. To check the progress, track the session state.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/backupInfrastructure/managedServers/rescan
Request samples 
application/json
{
  • "ids": [
    ]
}
Response samples 
application/json
{
  • "sessionType": "VolumesDiscover",
  • "state": "Starting",
  • "id": "6510ccdd-61eb-45e1-9a4c-16e569c39d2b",
  • "name": "Host Discovery",
  • "jobId": "ef6f75be-8015-47a3-8856-eb6a26452269",
  • "creationTime": "2025-05-19T14:17:09.596386+02:00",
  • "progressPercent": 0,
  • "result": {
    },
  • "usn": 47853
}
Rescan Managed Server
The HTTP POST request to the /api/v1/backupInfrastructure/managedServers/{id}/rescan endpoint rescans a managed server with the specified id. 
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Managed server ID. To get the ID, run the Get All Servers request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
201
A VolumesDiscover session has been created to rescan the specified managed servers. To check the progress, track the session state.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/backupInfrastructure/managedServers/{id}/rescan
Request samples 
Response samples 
application/json
{
  • "sessionType": "VolumesDiscover",
  • "state": "Starting",
  • "id": "6510ccdd-61eb-45e1-9a4c-16e569c39d2b",
  • "name": "Host Discovery",
  • "jobId": "ef6f75be-8015-47a3-8856-eb6a26452269",
  • "creationTime": "2025-05-19T14:17:09.596386+02:00",
  • "progressPercent": 0,
  • "result": {
    },
  • "usn": 47853
}
Default Set of Optional Managed Server Components
The HTTP GET request to the /api/v1/backupInfrastructure/managedServers/optionalComponents/defaults endpoint gets the default set of optional managed server components. 
Available to: Backup Administrator.
"


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/backupInfrastructure/managedServers/optionalComponents/defaults
Request samples 
Response samples 
application/json
{
  • "optionalComponents": [
    ]
}
Update Managed Server Components
The HTTP POST request to the /api/v1/backupInfrastructure/managedServers/updateComponents endpoint updates managed server components. 
Available to: Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
ids
Array of strings <uuid> 
Array of IDs of managed servers whose components must be updated. To get the IDs, run the Get All Servers request.


 
Responses 
201
A HostComponentsUpdate session has been created to update managed server components. To check the progress, track the session state.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/backupInfrastructure/managedServers/updateComponents
Request samples 
application/json
{
  • "ids": [
    ]
}
Response samples 
application/json
{
  • "sessionType": "HostComponentsUpdate",
  • "state": "Starting",
  • "id": "e6747e32-5da5-4be7-888f-8cbd62513c86",
  • "name": "Host Upgrade",
  • "jobId": "e6747e32-5da5-4be7-888f-8cbd62513c86",
  • "creationTime": "2025-05-20T12:43:45.431244+02:00",
  • "progressPercent": 0,
  • "result": {
    },
  • "usn": 125251
}