- About Veeam Backup & Replication REST API
- Overview
- How To
- Changelog
- Login
- Service
- Services
- Credentials
- getGet All Credentials
- postAdd Credentials Record
- getGet Credentials Record
- putEdit Credentials Record
- delRemove Credentials Record
- postChange Password
- postChange Linux Private Key
- postChange Linux Root Password
- getGet All Cloud Credentials
- postAdd Cloud Credentials Record
- postGet Microsoft Entra ID Verification Code
- postRegister Microsoft Entra ID Application
- postGet Google Authentication Information
- getGet Cloud Credentials Record
- putEdit Cloud Credentials Record
- delRemove Cloud Credentials Record
- postChange Secret Key
- postChange Google Service Account
- postChange Certificate
- getGet All Helper Appliances
- postAdd or Edit Helper Appliance
- getGet Helper Appliance
- delRemove Helper Appliance
- Encryption
- getGet All Encryption Passwords
- postAdd Encryption Password
- getGet Encryption Password
- putEdit Encryption Password Hint
- delRemove Encryption Password
- postChange Encryption Password
- postVerify Encryption Password
- getGet All KMS Servers
- postAdd KMS Server
- getGet KMS Server
- putEdit KMS Server
- delRemove KMS Server
- postChange KMS Server Certificate
- License
- postInstall License
- getGet Installed License
- postRemove License
- postCreate License Usage Report
- postRenew Installed License
- getGet Consumption of Socket Licenses
- postRevoke Socket License
- getGet Instance Licenses Consumption
- postAssign Instance License
- postRevoke Instance License
- postRemove Instance License
- getGet Capacity License Consumption
- postRevoke Capacity License From Unstructured Data Workload
- postUpdate License
- postEnable or Disable License Auto Update
- postEnable or Disable Instance Consumption for Unlicensed Agents
- Connection
- Cloud Browser
- Inventory Browser
- getGet All VMware vSphere Servers
- getGet VMware vSphere Server Objects
- postRescan Inventory Objects
- postGet All Servers
- postGet Inventory Objects
- postGet All Protection Groups
- postGet Inventory Objects for Specific Protection Group
- getGet All Unstructured Data Servers
- getGet Unstructured Data Servers
- getGet All Microsoft Entra ID Tenants
- postAdd Microsoft Entra ID Tenant
- getGet Microsoft Entra ID Tenant
- putEdit Microsoft Entra ID Tenant
- delRemove Microsoft Entra ID Tenant
- getGet Active Directory Objects from Domain
- Traffic Rules
- General Options
- Global Exclusions
- Security
- postStart Security & Compliance Analyzer
- getGet Security & Compliance Analyzer Last Run
- getGet Security & Compliance Analyzer Schedule
- putModify Security & Compliance Analyzer Schedule
- postReset All Security & Compliance Analyzer Statuses
- getGet Security & Compliance Analyzer Results
- postSuppress Security & Compliance Analyzer Best Practice Status
- postReset Security & Compliance Analyzer Status
- getGet All Authorization Events
- getGet Authorization Event
- Malware Detection
- Configuration Backup
- Deployment
- Managed Servers
- getGet All Servers
- postAdd Server
- postGet vCenter Servers Attached to Cloud Director Server
- postGet Hyper-V Servers Managed by Hyper-V Cluster or SCVMM Server
- getGet Server
- putEdit Server
- delRemove Server
- postChange to Single-Use Credentials
- getGet Volumes for Hyper-V Standalone Server
- putEdit Volumes on Hyper-V Standalone Server
- postRescan All Managed Servers
- postRescan Managed Server
- getDefault Set of Optional Managed Server Components
- postUpdate Managed Server Components
- Repositories
- getGet All Repositories
- postAdd Repository
- postRescan Repositories
- getGet All Repository States
- getGet Repository
- putEdit Repository
- delRemove Repository
- getGet All Scale-Out Backup Repositories
- postAdd Scale-Out Backup Repository
- getGet Scale-Out Backup Repository
- putEdit Scale-Out Backup Repository
- delRemove Scale-Out Backup Repository
- postEnable Sealed Mode
- postDisable Sealed Mode
- postEnable Maintenance Mode
- postDisable Maintenance Mode
- Mount Servers
- Proxies
- WAN Accelerators
- Jobs
- Backups
- Backup Objects
- Restore Points
- Restore
- getGet All Instant Recovery Mount Points of VMware vSphere VMs
- postStart Instant Recovery of VMware vSphere VM
- getGet Instant Recovery Mount Point of VMware vSphere VM
- postStop Publishing VMware vSphere VM
- postStart Migrating VMware vSphere VM
- getGet All Instant Recovery Mount Points of Microsoft Hyper-V VMs
- postStart Instant Recovery of Microsoft Hyper-V VM
- getGet Instant Recovery Mount Point of Microsoft Hyper-V VM
- postStop Publishing Microsoft Hyper-V VM
- postStart Migrating Microsoft Hyper-V VM
- getGet All Mount Points for Instant Recovery to Azure
- postStart Instant Recovery to Azure
- getGet Mount Point for Instant Recovery to Azure
- getGet All Mount Sessions for Instant Recovery to Azure
- postStop Publishing Machine to Azure
- postStart Migrating Machine to Azure
- getGet Settings for Switchover to Azure
- putUpdate Settings for Switchover to Azure
- postStart Switchover to Azure
- postRestore Entire VMware vSphere VM
- postRestore Entire VMware Cloud Director VM
- postRestore Entire Microsoft Hyper-V VM
- getGet All FCD Mount Points
- postStart Instant FCD Recovery
- getGet FCD Mount Point
- postStop FCD Publishing
- postStart FCD Migration
- postStart File Restore
- postUnmount File System
- postGet User Code for Delegated Restore of Microsoft Entra ID Items
- postGet Credentials for Delegated Restore of Microsoft Entra ID Items
- postMount Microsoft Entra ID Tenant
- postStart Microsoft Entra ID Tenant Restore from Copy
- postUnmount Microsoft Entra ID Tenant
- postStart Microsoft Entra ID Audit Log Restore
- postUnmount Microsoft Entra ID Audit Logs
- Data Integration API
- Backup Browsers
- postValidate Target Machine Credentials
- getGet All File Restore Mount Points
- getGet File Restore Mount Point
- getGet Restored Files Audit
- postBrowse File System
- postCompare Attributes
- postCompare Files and Folders
- postSearch for Files and Folders
- postBrowse Search Results
- postRestore Files and Folders to Original Location
- postRestore Files and Folders to Another Location
- postPrepare Files and Folders for Download
- postDownload Files and Folders
- getGet All Unstructured Data Mount Points
- getGet Unstructured Data Mount Point
- postBrowse Unstructured Data File System
- postSearch for Files and Folders in Unstructured Data Source
- postBrowse Search Results
- postCopy Files and Folders to Specific Folder
- getGet Mount Points of All Entra ID Tenants
- getGet Mount Point of Microsoft Entra ID Tenant
- postGet Restore Points of Microsoft Entra ID Tenant
- getGet Protection Scope of Microsoft Entra ID Tenant
- postGet Microsoft Entra ID Items
- postGet Microsoft Entra ID Item
- postGet Restore Points of Microsoft Entra ID Item
- postValidate Microsoft Entra ID Items
- postCheck Microsoft Entra ID Items in Production
- postGenerate Microsoft Entra ID User Passwords
- postRestore Microsoft Entra ID Items
- postRestore Microsoft Entra ID Item Properties
- postCompare Microsoft Entra ID Item Properties
- postStart Comparing Microsoft Entra ID Item Properties
- getGet Comparison Results for Microsoft Entra ID Items
- postStart Comparing Microsoft Entra ID Conditional Access Policy
- getGet Comparison Results for Microsoft Entra ID Conditional Access Policy
- postExport Microsoft Entra ID Items
- postUpload Microsoft Entra ID Users
- postUpload Microsoft Entra ID Groups
- postUpload Microsoft Entra ID Administrative Units
- postUpload Microsoft Entra ID Roles
- postUpload Microsoft Entra ID Applications
- postUpload Microsoft Entra ID Conditional Access Policies
- getGet All Restore Sessions of Microsoft Entra ID Tenant
- getGet Restore Session of Microsoft Entra ID Tenant
- getGet Restore Session Logs of Microsoft Entra ID Tenant
- postStop Restore Session of Microsoft Entra ID Tenant
- Tasks
- Replicas
- Replica Restore Points
- Failover
- Failback
- Sessions
- Agents
- getGet All Recovery Tokens
- postCreate Recovery Token
- getGet Recovery Token
- putEdit Recovery Token
- delDelete Recovery Token
- getGet All Protected Computers
- getGet Protected Computer
- getGet Discovered Entities
- postRescan Discovered Entities
- postInstall Agent on Discovered Entities
- postUninstall Agent from Discovered Entities
- postUninstall All Components from Discovered Entities
- getGet Discovered Entity
- delRemove Discovered Entity
- getGet Linux Agent Packages
- getGet Unix Agent Packages
- Protection Groups
- Active Directory Domains
- Automation
- postImport Jobs
- postExport Jobs
- postImport Credentials
- postExport Credentials
- postImport Cloud Credentials
- postExport Cloud Credentials
- postImport Proxies
- postExport Proxies
- postImport Servers
- postExport Servers
- postImport Repositories
- postExport Repositories
- postImport Encryption Passwords
- postExport Encryption Passwords
- getGet All Automation Sessions
- getGet Automation Session
- getGet Automation Session Logs
- postStop Automation Session
- Log export
The Managed Servers section defines paths and operations for managing servers.
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
path allows you to get an array of all servers that are added to the backup infrastructure.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.
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. |
orderAsc | boolean If |
nameFilter | string Filters servers by the |
typeFilter | Array of strings (EManagedServerType) Filters servers by server type. |
viTypeFilter | string (EViHostType) Filters servers by the type of VMware vSphere server. |
serverStateFilter | string (EManagedServerState) Filters servers by the their state. |
updatesStateFilter | Array of strings (EHostUpdatesState) Filters servers by updatesState (only for Linux hosts). |
includeNestedHosts | boolean If |
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
OK
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 401
- 403
- 500
{- "data": [
- {
- "sshSettings": {
- "sshTimeOutMs": 20000,
- "portRangeStart": 2500,
- "portRangeEnd": 3300,
- "serverSide": false,
- "managementPort": 6162
}, - "type": "LinuxHost",
- "id": "535b5414-788d-4720-a53a-ecc830d2589b",
- "name": "172.17.53.67",
- "description": "Created by TECH\\sheila.d.cory",
- "credentialsId": "b860489e-490d-4e43-b20a-a91c4e7d2e76"
}, - {
- "networkSettings": {
- "components": [
- {
- "componentName": "DeployerSvc",
- "port": 6160
}, - {
- "componentName": "Transport",
- "port": 6162
}, - {
- "componentName": "Nfs",
- "port": 6161
}, - {
- "componentName": "RestoreProxy",
- "port": 6170
}, - {
- "componentName": "WanAccelerator",
- "port": 6164
}, - {
- "componentName": "Tape",
- "port": 6166
}, - {
- "componentName": "CloudGate",
- "port": 6168
}, - {
- "componentName": "AgentConfigureService",
- "port": 9380
}, - {
- "componentName": "FileSystemVssIntegration",
- "port": 6210
}, - {
- "componentName": "VssHwSnapshotProvider",
- "port": 6211
}
], - "portRangeStart": 2500,
- "portRangeEnd": 3300,
- "serverSide": false
}, - "type": "WindowsHost",
- "id": "ee50f2fb-034f-41cd-8dc8-904aeae2d0d8",
- "name": "enterprise04.tech.local",
- "description": "Created by TECH\\sheila.d.cory",
- "credentialsId": "fa4769b5-6722-4968-838b-866c29bd14d4"
}, - {
- "viHostType": "VC",
- "port": 443,
- "type": "ViHost",
- "id": "de28dc43-b8ee-4e17-8e63-3d38b6604033",
- "name": "vcenter01.tech.local",
- "description": "Created by TECH\\administrator",
- "credentialsId": "fa4769b5-6722-4968-838b-866c29bd14d4"
}
], - "pagination": {
- "total": 3,
- "count": 3,
- "skip": 0,
- "limit": 200
}
}
Add Server
The HTTP POST request to the /api/v1/backupInfrastructure/managedServers
path allows you to add a server to the backup infrastructure.
If you want to add a Microsoft Hyper-V cluster and include only specific Hyper-V hosts, follow these steps:
- 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.
- Discover the hosts managed by the cluster: Get Hyper-V Servers Managed by Hyper-V Cluster or SCVMM Server.
- 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 Hyper-V hosts, follow these steps:
- 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.
- To add an SCVMM server without hosts, use this request and set
addAllServers
tofalse
in the request body . - Discover the hosts managed by the SCVMM server: Get Hyper-V Servers Managed by Hyper-V Cluster or SCVMM Server.
- To add the necessary hosts, edit the SCVMM server: Edit Server.
Available to: Veeam Backup Administrator.
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonrequired
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 Linux server. |
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. |
An Infrastructure
session has been created to add the server. To check the progress, track the session state
.
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "networkSettings": {
- "components": [
- {
- "componentName": "DeployerSvc",
- "port": 6160
}, - {
- "componentName": "Transport",
- "port": 6162
}, - {
- "componentName": "Nfs",
- "port": 6161
}, - {
- "componentName": "RestoreProxy",
- "port": 6170
}, - {
- "componentName": "WanAccelerator",
- "port": 6164
}, - {
- "componentName": "Tape",
- "port": 6166
}, - {
- "componentName": "CloudGate",
- "port": 6168
}, - {
- "componentName": "AgentConfigureService",
- "port": 9380
}, - {
- "componentName": "FileSystemVssIntegration",
- "port": 6210
}, - {
- "componentName": "VssHwSnapshotProvider",
- "port": 6211
}
], - "portRangeStart": 2517,
- "portRangeEnd": 3313,
- "serverSide": true
}, - "type": "WindowsHost",
- "name": "enterprise01.tech.local",
- "description": "Backup Repository",
- "credentialsId": "d7af15f3-8808-454e-ba79-2c2267acb05d"
}
- 201
- 400
- 401
- 403
- 500
{- "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": {
- "result": "None",
- "message": "",
- "isCanceled": false
}, - "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
path allows you to get an array of vCenter Servers attached to a specific VMware Cloud Director server.
Available to: Veeam Backup Administrator.
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonrequired
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. |
OK
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "url": "string",
- "credentialsId": "08e8bcd2-3d30-4d03-8e1a-ab6ac0cbf1ed",
- "certificateThumbprint": "string"
}
- 200
- 400
- 401
- 403
- 500
{- "data": [
- {
- "viServerName": "string",
- "certificateThumbprint": "string"
}
]
}
Get Hyper-V Servers Managed by Hyper-V Cluster or SCVMM Server
The HTTP POST request to the /api/v1/backupInfrastructure/managedServers/hyperVHosts
path allows you to get 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: Veeam Backup Administrator.
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonrequired
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. |
OK
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "credentialsId": "8f2e6fa5-4757-4312-a4b2-73b9325df6a4",
- "hvClusterName": "twhv19cluster.tech.local"
}
- 200
- 400
- 401
- 403
- 500
{- "data": [
- {
- "hvServerName": "string"
}
], - "pagination": {
- "total": 0,
- "count": 0,
- "skip": 0,
- "limit": 0
}
}
Get Server
The HTTP GET request to the /api/v1/backupInfrastructure/managedServers/{id}
path allows you to get a managed server that has the specified id
.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.
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-rev0 Version and revision of the client REST API. Must be in the following format: |
OK
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 401
- 403
- 404
- 500
{- "credentialsStorageType": "Permanent",
- "credentialsId": "ccddfca4-571d-4d1e-9609-f709d219326b",
- "networkSettings": {
- "components": [
- {
- "componentName": "InstallerSvc",
- "port": 6160
}, - {
- "componentName": "TransportSvc",
- "port": 6162
}, - {
- "componentName": "HvIntegration",
- "port": 6163
}, - {
- "componentName": "GuestInteractionProxy",
- "port": 6190
}
], - "portRangeStart": 2500,
- "portRangeEnd": 3300,
- "serverSide": true
}, - "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}
path allows you to edit a managed server that has the specified id
.
Available to: Veeam Backup Administrator.
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-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonrequired
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. |
credentialsStorageType required | string (ECredentialsStorageType) Credentials type used to connect to the Linux server. |
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 |
isDefaultMountServer | boolean If |
updatesState | string (EHostUpdatesState) Host updates state. |
An Infrastructure
session has been created to edit the server. To check the progress, track the session state
.
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "credentialsStorageType": "Permanent",
- "credentialsId": "ccddfca4-571d-4d1e-9609-f709d219326b",
- "networkSettings": {
- "components": [
- {
- "componentName": "InstallerSvc",
- "port": 6160
}, - {
- "componentName": "TransportSvc",
- "port": 6162
}, - {
- "componentName": "HvIntegration",
- "port": 6163
}, - {
- "componentName": "GuestInteractionProxy",
- "port": 6190
}
], - "portRangeStart": 2500,
- "portRangeEnd": 3300,
- "serverSide": true
}, - "maxTaskCount": 4,
- "type": "HvServer",
- "status": "Available",
- "id": "8a689010-07a6-4b3c-9a26-786c8fad2e70",
- "name": "pdctwhv02.tech.local",
- "description": "Microsof Hyper-V host created by .\\veeamadmin"
}
- 201
- 400
- 401
- 403
- 404
- 500
{- "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": {
- "result": "None",
- "message": "",
- "isCanceled": false
}, - "usn": 331548,
- "initiatedBy": ".\\veeam-rest-service"
}
Remove Server
The HTTP DELETE request to the /api/v1/backupInfrastructure/managedServers/{id}
path allows you to remove a managed server that has the specified id
from the backup infrastructure.
Available to: Veeam Backup Administrator.
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-rev0 Version and revision of the client REST API. Must be in the following format: |
An InfrastructureItemDeletion
session has been created to remove the server. To check the progress, track the session state
.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 201
- 401
- 403
- 404
- 500
{- "sessionType": "InfrastructureItemDeletion",
- "state": "Working",
- "id": "af1a6027-3845-487e-9a16-6849f4775a1e",
- "name": "Infrastructure Item Deletion",
- "jobId": "fc5683a4-8c25-4f8e-97cc-0a40745a5729",
- "creationTime": "2025-06-28T20:21:08.81+01:00",
- "endTime": null,
- "progressPercent": 0,
- "result": null,
- "resourceId": null,
- "resourceReference": null,
- "parentSessionId": null,
- "usn": 0
}
Change to Single-Use Credentials
The HTTP POST request to the /api/v1/backupInfrastructure/managedServers/{id}/updateSingleUseCredentials
path allows you to change from persistent to single-use credentials used to access 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: Veeam Backup Administrator.
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-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonrequired
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. |
An Infrastructure
session has been created to edit the server. To check the progress, track the session state
.
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "username": "string",
- "description": "string",
- "type": "Standard",
- "uniqueId": "string",
- "password": "string"
}
- 201
- 400
- 401
- 403
- 404
- 500
{- "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": {
- "result": "None",
- "message": "",
- "isCanceled": false
}, - "usn": 331548,
- "initiatedBy": ".\\veeam-rest-service"
}
Get Volumes for Hyper-V Standalone Server
The HTTP GET request to the /api/v1/backupInfrastructure/managedServers/{id}/volumes
path allows you to get volumes on managed server that has the specified id
. Applicable only for Microsoft Hyper-V standalone server
Available to: Veeam Backup Administrator.
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-rev0 Version and revision of the client REST API. Must be in the following format: |
OK
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 401
- 403
- 404
- 500
{- "volumes": [
- {
- "volume": {
- "platform": "VSphere",
- "size": "string",
- "hostName": "string",
- "name": "string",
- "type": "Unknown",
- "objectId": "string",
- "urn": "string",
- "isEnabled": true,
- "metadata": [
- {
- "field": "string",
- "data": "string"
}
]
}, - "volumeSettings": {
- "VSSprovider": "string",
- "maxSnapshots": 0
}
}
], - "changedBlockTracking": false,
- "failoverToVSSProvider": true
}
Edit Volumes on Hyper-V Standalone Server
The HTTP PUT request to the /api/v1/backupInfrastructure/managedServers/{id}/volumes
path allows you to edit particular volumes.
Available to: Veeam Backup Administrator.
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-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonrequired
changedBlockTracking required | boolean Default: false If |
failoverToVSSProvider required | boolean Default: true If |
required | Array of objects (HyperVVolumeObjectModel) Array of volumes. |
Volumes have been updated.
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "volumes": [
- {
- "volume": {
- "platform": "VSphere",
- "size": "string",
- "hostName": "string",
- "name": "string",
- "type": "Unknown",
- "objectId": "string",
- "urn": "string",
- "isEnabled": true,
- "metadata": [
- {
- "field": "string",
- "data": "string"
}
]
}, - "volumeSettings": {
- "VSSprovider": "string",
- "maxSnapshots": 0
}
}
], - "changedBlockTracking": false,
- "failoverToVSSProvider": true
}
- 200
- 400
- 401
- 403
- 404
- 500
{- "volumes": [
- {
- "volume": {
- "platform": "VSphere",
- "size": "string",
- "hostName": "string",
- "name": "string",
- "type": "Unknown",
- "objectId": "string",
- "urn": "string",
- "isEnabled": true,
- "metadata": [
- {
- "field": "string",
- "data": "string"
}
]
}, - "volumeSettings": {
- "VSSprovider": "string",
- "maxSnapshots": 0
}
}
], - "changedBlockTracking": false,
- "failoverToVSSProvider": true
}
Rescan All Managed Servers
The HTTP POST request to the /api/v1/backupInfrastructure/managedServers/rescan
path allows you to rescan all managed servers.
Available to: Veeam Backup Administrator.
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
A VolumesDiscover
session has been created to rescan all managed servers. To check the progress, track the session state
.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 201
- 401
- 403
- 404
- 500
{- "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": {
- "result": "None",
- "message": "",
- "isCanceled": false
}, - "usn": 47853
}
Rescan Managed Server
The HTTP POST request to the /api/v1/backupInfrastructure/managedServers/{id}/rescan
path allows you to rescan a managed server with the specified id
.
Available to: Veeam Backup Administrator.
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-rev0 Version and revision of the client REST API. Must be in the following format: |
A VolumesDiscover
session has been created to rescan the specified managed servers. To check the progress, track the session state
.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 201
- 401
- 403
- 404
- 500
{- "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": {
- "result": "None",
- "message": "",
- "isCanceled": false
}, - "usn": 47853
}
Default Set of Optional Managed Server Components
The HTTP GET request to the /api/v1/backupInfrastructure/managedServers/optionalComponents/defaults
path allows you to get the default set of optional managed server components.
Available to: Veeam Backup Administrator.
"header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
OK
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 401
- 403
- 500
{- "optionalComponents": [
- {
- "displayName": "string",
- "optionalComponent": "CatalystSdk"
}
]
}
Update Managed Server Components
The HTTP POST request to the /api/v1/backupInfrastructure/managedServers/updateComponents
path allows you to update managed server components.
Available to: Veeam Backup Administrator.
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonrequired
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. |
A HostComponentsUpdate
session has been created to update managed server components. To check the progress, track the session state
.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "ids": [
- "4464c669-c8b0-4d11-b926-f907c3568c85",
- "6745a759-2205-4cd2-b172-8ec8f7e60ef8"
]
}
- 201
- 401
- 403
- 404
- 500
{- "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": {
- "result": "None",
- "message": "",
- "isCanceled": false
}, - "usn": 125251
}