Veeam Backup & Replication 13
REST API Reference
Related documents

Inventory Browser

The Inventory Browser section defines operations that allow you to:

  • Retrieve virtualization servers and their virtual infrastructure objects (data centers, clusters, hosts, resource pools, vApps, VMs and so on). In this version, you can browse VMware vSphere, VMware Cloud Director and Microsoft Hyper-V objects.
  • Manage computers, cloud machines, clusters and Active Directory objects with protection groups.
  • Manage unstructured data sources.
  • Manage Microsoft Entra ID tenants.

Get All VMware vSphere ServersDeprecated

The HTTP GET request to the /api/v1/inventory/vmware/hosts endpoint gets an array of all VMware vSphere servers added to the backup infrastructure.

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

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of VMware vSphere servers to skip.

limit
integer <int32>
Default: 200

Maximum number of VMware vSphere servers to return.

orderColumn
string (EViRootFiltersOrderColumn)

Sorts VMware vSphere servers by one of the VMware vSphere server parameters.

Enum: "Name" "Type"
orderAsc
boolean

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

nameFilter
string

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

permissionScope
string (EInventoryPermissionScope)

Permission scope type (advanced RBAC) for filtering inventory objects. If the value is Any, inventory objects valid under any permission scope are returned.

Enum: "Backup" "Restore" "Any"
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/inventory/vmware/hosts
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get VMware vSphere Server ObjectsDeprecated
The HTTP GET request to the /api/v1/inventory/vmware/hosts/{name} endpoint gets an array of virtual infrastructure objects of the VMware vSphere server that has the specified name.
Available to: Backup Administrator, Backup Operator, Restore Operator. Also available to custom roles that have backup or restore permissions.


SecurityBearer 
Request 
path Parameters
name
required
string
Name of the VMware vSphere server.


 
query Parameters
skip
integer <int32> 
Number of objects to skip.


 
limit
integer <int32> 
 Default:  200
Maximum number of objects to return.


 
orderColumn
string (EvCentersInventoryFiltersOrderColumn) 
Sorts objects by one of the object parameters.


 Enum: "Name" "ObjectId" "Type"  
orderAsc
boolean
If true, sorts objects in ascending order by the orderColumn parameter.


 
objectIdFilter
string
Filters objects by object ID.


 
hierarchyTypeFilter
string (EHierarchyType) 
Filters objects by hierarchy type.


 Enum: "HostsAndClusters" "DatastoresAndVms" "HostsAndDatastores" "VmsAndTemplates" "VmsAndTags" "Network" "VmwareDatastores" "HostsAndDisks"  
nameFilter
string
Filters objects by the nameFilter pattern. The pattern can match any object parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.


 
typeFilter
string (EVmwareInventoryType) 
Filters objects by virtual infrastructure type.


 Enum: "Unknown" "VirtualMachine" "vCenterServer" "Datacenter" "Cluster" "Host" "ResourcePool" "Folder" "Datastore" "DatastoreCluster" "StoragePolicy" "Template" "ComputeResource" "VirtualApp" "Tag" "Category" "Multitag" "Network" "DVSNetwork" "Disk" "SharedDisk"  
parentContainerNameFilter
string
Filters objects by name of the parent container.


 
permissionScope
string (EInventoryPermissionScope) 
Permission scope type (advanced RBAC) for filtering inventory objects. If the value is Any, inventory objects valid under any permission scope are returned.


 Enum: "Backup" "Restore" "Any"  
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/inventory/vmware/hosts/{name}
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Rescan Inventory ObjectsDeprecated
The HTTP POST request to the /api/v1/inventory/{hostname}/rescan endpoint rescans inventory objects of a virtualization server (or host) that has the specified hostname.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
hostname
required
string
Name of the server.


 
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 HierarchyRescan task has been started. To check the progress, track the task 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/inventory/{hostname}/rescan
Request samples 
Response samples 
application/json
{
  • "type": "Common",
  • "id": "c3d4e5f6-7a8b-49c0-8d1e-2f3a4b5c6d7e",
  • "name": "Rescan repository task",
  • "state": "Working",
  • "progressPercent": 45,
  • "creationTime": "2026-05-20T10:30:00Z",
  • "endTime": "2026-05-20T10:42:00Z",
  • "result": "None"
}
Get All Servers
The HTTP POST request to the /api/v1/inventory endpoint gets an array of all servers and hosts added to the backup infrastructure.
TIP 
To filter servers by type, use the following possible values:
     
  • For VMware VSphere: VCenterServer, Folder, Host
    •  
  • For VMware Cloud Director: CloudDirectorServer
    •  
  • For Microsoft Hyper-V: Scvmm, Cluster, Host
    •  
For details, see request samples.
To browse Veeam Agents inventory, run the Get All Protection Groups request.
 
Available to: Backup Administrator, Backup Operator, Restore Operator. Also available to custom roles that have backup or restore permissions.


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
object (PaginationFilter) 
Pagination settings.


 
object (FilterExpressionModel) 
Filter settings.


 
object (SortExpressionModel) 
Sorting settings.


 
hierarchyType
string
Hierarchy type. The possible values you can specify depend on the used request. 
 


 
permissionScope
string (EInventoryPermissionScope) 
Inventory permission scope.


 Enum: "Backup" "Restore" "Any"  
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.


post/api/v1/inventory
Request samples 
application/json
{
  • "filter": {
    },
  • "sorting": {
    }
}
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    },
  • "hierarchyType": null
}
Get Inventory Objects
The HTTP POST request to the /api/v1/inventory/{hostname} endpoint gets an array of inventory objects of a virtualization server (or host) that has the specified hostname.
Available to: Backup Administrator, Backup Operator, Restore Operator. Also available to custom roles that have backup or restore permissions.


SecurityBearer 
Request 
path Parameters
hostname
required
string
DNS name or IP address of the server. To get this value, 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
object (PaginationFilter) 
Pagination settings.


 
object (FilterExpressionModel) 
Filter settings.


 
object (SortExpressionModel) 
Sorting settings.


 
hierarchyType
string
Hierarchy type. The possible values you can specify depend on the used request. 
 


 
permissionScope
string (EInventoryPermissionScope) 
Inventory permission scope.


 Enum: "Backup" "Restore" "Any"  
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.


post/api/v1/inventory/{hostname}
Request samples 
application/json
{
  • "filter": {
    },
  • "sorting": {
    }
}
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    },
  • "hierarchyType": "Hosts"
}
Get Inventory Object Details
The HTTP POST request to the /api/v1/inventory/retrieveMachineDetails endpoint returns detailed information about the specified inventory object. 
Available to: Backup Administrator, Backup Operator, Restore Operator. Also available to custom roles that have backup or restore permissions.


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
object (InventoryObjectModel) 
Inventory object properties.


 
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.


post/api/v1/inventory/retrieveMachineDetails
Request samples 
application/json
{
  • "object": {
    }
}
Response samples 
application/json
{
  • "platform": "VSphere",
  • "disks": [
    ]
}
Get All Protection Groups
The HTTP POST request to the /api/v1/inventory/physical endpoint gets an array of protection groups added to the physical and cloud infrastructure. 
 NOTE 
 This request is only used to get protected computers in order to add them to a backup job. For more information on how to get, add and manage protection groups, see the Agents section.
 
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have backup or restore permissions.


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
object (PaginationFilter) 
Pagination settings.


 
object (FilterExpressionModel) 
Filter settings.


 
object (SortExpressionModel) 
Sorting settings.


 
hierarchyType
string
Hierarchy type. The possible values you can specify depend on the used request. 
 


 
permissionScope
string (EInventoryPermissionScope) 
Inventory permission scope.


 Enum: "Backup" "Restore" "Any"  
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.


post/api/v1/inventory/physical
Request samples 
application/json
{
  • "filter": {
    },
  • "sorting": {
    }
}
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get All Physical Inventory
The HTTP POST request to the /api/v1/inventory/physical/all endpoint gets an array of all protection groups together with the inventory objects of physical or cloud machines that belong to them. 
 NOTE 
 This request is only used to get protected computers in order to add them to a backup job. For more information on how to get, add and manage protection groups, see the Agents section.
 
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have backup or restore permissions.


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
object (PaginationFilter) 
Pagination settings.


 
object (FilterExpressionModel) 
Filter settings.


 
object (SortExpressionModel) 
Sorting settings.


 
hierarchyType
string
Hierarchy type. The possible values you can specify depend on the used request. 
 


 
permissionScope
string (EInventoryPermissionScope) 
Inventory permission scope.


 Enum: "Backup" "Restore" "Any"  
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.


post/api/v1/inventory/physical/all
Request samples 
application/json
{
  • "filter": {
    },
  • "sorting": {
    }
}
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Inventory Objects for Specific Protection Group
The HTTP POST request to the /api/v1/inventory/physical/{protectionGroupId} endpoint gets an array of inventory objects of physical or cloud machines for a protection group with the specified protectionGroupId. 
Available to: Backup Administrator, Restore Operator. Also available to custom roles that have backup or restore permissions.


SecurityBearer 
Request 
path Parameters
protectionGroupId
required
string <uuid> 
Protection group ID. To get the ID, run the Get All Protection Groups 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
object (PaginationFilter) 
Pagination settings.


 
object (FilterExpressionModel) 
Filter settings.


 
object (SortExpressionModel) 
Sorting settings.


 
hierarchyType
string
Hierarchy type. The possible values you can specify depend on the used request. 
 


 
permissionScope
string (EInventoryPermissionScope) 
Inventory permission scope.


 Enum: "Backup" "Restore" "Any"  
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.


post/api/v1/inventory/physical/{protectionGroupId}
Request samples 
application/json
{
  • "filter": {
    },
  • "sorting": {
    }
}
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get All Unstructured Data Servers
The HTTP GET request to the /api/v1/inventory/unstructuredDataServers endpoint gets an array of unstructured data servers available on a backup server.
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 unstructured data servers to skip.


 
limit
integer <int32> 
 Default:  200
Maximum number of unstructured data servers to return.


 
orderColumn
string (EUnstructuredDataServersFiltersOrderColumn) 
Sorts unstructured data servers by one of the unstructured data server parameters.


 Enum: "Name" "Description" "Type" "Region"  
orderAsc
boolean
If true, sorts unstructured data servers in ascending order by the orderColumn parameter.


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


 
typeFilter
Array of strings (EUnstructuredDataServerType) 
Filters unstructured data servers by type.


Items Enum: "FileServer" "SMBShare" "NFSShare" "NASFiler" "S3Compatible" "AmazonS3" "AzureBlob" "AzureDataLake" "SANSMBShare" "SANNFSShare"  
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/inventory/unstructuredDataServers
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Unstructured Data Servers
The HTTP POST request to the /api/v1/inventory/unstructuredDataServers endpoint adds unstructured data servers to the backup 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
type
required
string (EUnstructuredDataServerType) 
Type of unstructured data server.


 
hostId
required
string <uuid> 
Host ID. To get the ID, run the Get All Servers request.


 
required
object (FileServerProcessingModel) 
File server processing settings.


 
Responses 
201
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/inventory/unstructuredDataServers
Request samples 
application/json
{
  • "type": "FileServer",
  • "hostId": "a1b2c3d4-1111-4a2b-9c3d-4e5f6a7b8c9d",
  • "processing": {
    }
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Get Unstructured Data Server Defaults
The HTTP GET request to the /api/v1/inventory/unstructuredDataServers/defaults endpoint returns unstructured data server defaults, such as default cache repository, and so on.
Available to: Backup Administrator, Backup Operator, Restore Operator, Backup Viewer. Also available to custom roles that have backup or restore permissions.


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/inventory/unstructuredDataServers/defaults
Request samples 
Response samples 
application/json
{ }
Get Unstructured Data Server
The HTTP GET request to the /api/v1/inventory/unstructuredDataServers/{id} endpoint gets an unstructured data 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> 
ID of the unstructured data server. To get the ID, run the Get All Unstructured Data 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/inventory/unstructuredDataServers/{id}
Request samples 
Response samples 
application/json
{
  • "id": "f2a3b4c5-9999-4c0d-9e1f-2a3b4c5d6e7f",
  • "type": "FileServer",
  • "name": "enterprise01.tech.local",
  • "hostId": "a1b2c3d4-1111-4a2b-9c3d-4e5f6a7b8c9d",
  • "hostType": "Windows",
  • "processing": {
    }
}
Edit Unstructured Data Server
The HTTP PUT request to the /api/v1/inventory/unstructuredDataServers/{id} endpoint edits an unstructured data server that has the specified id.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the unstructured data server. To get the ID, run the Get All Unstructured Data Servers request.


 
query Parameters
migrationType
string (EUnstructuredDataMetaMigrationType) 
 Default:  "CopyMetaFromCache"
Meta migration type for the unstructured data server cache repository.


 Enum: "CheckExistence" "CopyMetaFromCache" "DownloadMetaFromArchive"  
coldStorageRetrievalMode
string (EColdStorageRetrievalMode) 
Meta migration type for the unstructured data server cache repository.


 Enum: "AmazonBulk" "AmazonStandard" "AmazonExpedited" "AzureStandardPriority" "AzureHighPriority"  
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
id
required
string <uuid> 
ID of the unstructured data server.


 
type
required
string (EUnstructuredDataServerType) 
Type of unstructured data server.


 
hostId
required
string <uuid> 
Host ID.


 
required
object (FileServerProcessingModel) 
File server processing settings.


 
name
string
DNS name of the file server.


 
hostType
string (EFileServerHostType) 
Type of the host that backs the file server. Identifies whether the file server is a Linux machine, a Windows machine or the Veeam Backup & Replication server itself. Set by the server; ignored on write.


 Enum: "Windows" "Linux" "BackupServer"  
Responses 
201
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.


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/inventory/unstructuredDataServers/{id}
Request samples 
application/json
{
  • "id": "f2a3b4c5-9999-4c0d-9e1f-2a3b4c5d6e7f",
  • "type": "FileServer",
  • "name": "enterprise01.tech.local",
  • "hostId": "a1b2c3d4-1111-4a2b-9c3d-4e5f6a7b8c9d",
  • "hostType": "Windows",
  • "processing": {
    }
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Remove Unstructured Data Server
The HTTP DELETE request to the /api/v1/inventory/unstructuredDataServers/{id} endpoint removes an unstructured data server that has the specified id.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the unstructured data server. To get the ID, run the Get All Unstructured Data 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 (FileServer or NasFiler deleted).


201
OK (NasServer deleted).


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/inventory/unstructuredDataServers/{id}
Request samples 
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Start Browsing Unstructured Data Server
The HTTP POST request to the /api/v1/inventory/unstructuredDataServers/{id}/startBrowse endpoint starts browsing an unstructured data server added to the backup server.
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> 
Unstructured data server ID. To get the ID, run the Get All Unstructured Data Servers request.


 
query Parameters
timeout
integer <int32> 
Timeout in minutes.


 
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
Browse session has been started.


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/inventory/unstructuredDataServers/{id}/startBrowse
Request samples 
Response samples 
application/json
{
  • "sessionId": "10203040-6a6a-4d7e-8f8a-9b0c1d2e3f40",
  • "serverId": "f2a3b4c5-9999-4c0d-9e1f-2a3b4c5d6e7f",
  • "serverName": "enterprise01.tech.local",
  • "timeout": 600,
  • "pathSeparator": "\\",
  • "rootPath": "\\\\enterprise01.tech.local\\Share"
}
Browse Unstructured Data Server
The HTTP POST request to the /api/v1/inventory/unstructuredDataServers/sessions/{id}/browse endpoint browses the content of an unstructured data server within the browse session 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> 
Browse session ID. To get the ID, run the Get All Unstructured Data Server Inventory Browse Sessions 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
path
required
string
Browsing path.


 
pathType
string (EUnstructuredDataInventoryBrowseItemType) 
Unstructured data item type.


 Enum: "Drive" "Folder" "File"  
object (UnstructuredDataInventoryBrowseFiltrationModel) 
Filter settings.


 
object (UnstructuredDataInventoryBrowseOrderSpec) 
Sorting settings.


 
object (PaginationSpec) 
Pagination settings.


 
Responses 
201
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.


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/inventory/unstructuredDataServers/sessions/{id}/browse
Request samples 
application/json
{
  • "path": "\\\\enterprise01.tech.local\\Share\\Documents",
  • "pathType": "Folder",
  • "pagination": {
    }
}
Response samples 
application/json
{
  • "path": "\\\\enterprise01.tech.local\\Share\\Documents",
  • "items": [
    ],
  • "pagination": {
    }
}
Stop Browsing Unstructured Data Server
The HTTP POST request to the /api/v1/inventory/unstructuredDataServers/sessions/{id}/stop endpoint stops browsing an unstructured data server within the browse session 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> 
Browse session ID. To get the ID, run the Get All Unstructured Data Server Inventory Browse Sessions 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
Browse session has been stopped.


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/inventory/unstructuredDataServers/sessions/{id}/stop
Request samples 
Response samples 
application/json
{
  • "sessionId": "10203040-6a6a-4d7e-8f8a-9b0c1d2e3f40",
  • "serverId": "f2a3b4c5-9999-4c0d-9e1f-2a3b4c5d6e7f",
  • "serverName": "enterprise01.tech.local",
  • "timeout": 600,
  • "pathSeparator": "\\",
  • "rootPath": "\\\\enterprise01.tech.local\\Share"
}
Get All Unstructured Data Server Inventory Browse Sessions
The HTTP GET request to the /api/v1/inventory/unstructuredDataServers/sessions endpoint gets an array of unstructured data server inventory browse sessions available on the backup server.
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 sessions to skip.


 
limit
integer <int32> 
 Default:  200
Maximum number of sessions to return.


 
orderColumn
string (EUnstructuredDataInventoryBrowseSessionsFiltersOrderColumn) 
Sorts sessions by one of the session parameters.


 Value: "ServerName"  
orderAsc
boolean
If true, sorts sessions in ascending order by the orderColumn parameter.


 
sessionIdFilter
string
Filters sessions by the sessionIdFilter pattern. The pattern can match any sessionId parameter.


 
serverIdFilter
string
Filters sessions by the serverIdFilter pattern. The pattern can match any serverId parameter.


 
serverNameFilter
string
Filters sessions by the serverNameFilter pattern. The pattern can match any serverName parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.


 
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/inventory/unstructuredDataServers/sessions
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Unstructured Data Server Inventory Browse Session
The HTTP GET request to the /api/v1/inventory/unstructuredDataServers/sessions/{id} endpoint gets an unstructured data server inventory browse session 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> 
Browse session ID. To get the ID, run the Get All Unstructured Data Server Inventory Browse Sessions 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/inventory/unstructuredDataServers/sessions/{id}
Request samples 
Response samples 
application/json
{
  • "sessionId": "10203040-6a6a-4d7e-8f8a-9b0c1d2e3f40",
  • "serverId": "f2a3b4c5-9999-4c0d-9e1f-2a3b4c5d6e7f",
  • "serverName": "enterprise01.tech.local",
  • "timeout": 600,
  • "pathSeparator": "\\",
  • "rootPath": "\\\\enterprise01.tech.local\\Share"
}
Get All Microsoft Entra ID Tenants
The HTTP GET request to the /api/v1/inventory/entraId/tenants endpoint gets an array of all Microsoft Entra ID tenants added to the backup server.
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 Microsoft Entra ID tenants to skip.


 
limit
integer <int32> 
 Default:  200
Maximum number of Microsoft Entra ID tenants to return.


 
orderColumn
string (EEntraIDTenantsFiltersOrderColumn) 
Sorts Microsoft Entra ID tenants by one of the tenant parameters.


 Enum: "Name" "Description"  
orderAsc
boolean
If true, sorts Microsoft Entra ID tenants in ascending order by the orderColumn parameter.


 
nameFilter
string
Filters Microsoft Entra ID tenants by the nameFilter pattern. The pattern can match any Microsoft Entra ID tenant parameter. To substitute one or more characters, use the asterisk (*) character at the beginning and/or at the end.


 
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/inventory/entraId/tenants
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Microsoft Entra ID Tenant
The HTTP POST request to the /api/v1/inventory/entraId/tenants endpoint adds a Microsoft Entra ID tenant to the backup server. 
When adding a tenant, specify an existing Microsoft Entra ID app registration or let Veeam Backup & Replication create a new one. If you choose to create a new app registration, you must generate a verification code and register the new application before you start adding a tenant: 
  1. To generate a code, run the Get Microsoft Entra ID Verification Code request.
    2.  
  2. To register the new application, run the Register Microsoft Entra ID Application request.
 
 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
azureTenantId
required
string <uuid> 
Tenant ID assigned by Microsoft Entra ID.


 
creationMode
required
string (EEntraIDTenantCreationMode) 
Connection method that defines whether you want to connect to Microsoft Entra ID using an existing or a newly created app registration.


 Enum: "NewAccount" "ExistingAccount"  
description
string
Tenant description.


 
cacheRepositoryId
string <uuid> 
ID of a backup repository that is used as a cache repository for the tenant. If you do not specify the ID, the default backup repository is used.


 
region
string (EAzureRegionType) 
Microsoft Azure region.


 Enum: "China" "Global" "Government"  
object (EntraIDTenantExistingAccountSpec) 
Existing Microsoft Entra ID app registration.


 
object (EntraIDTenantNewAccountSpec) 
New Microsoft Entra ID app registration.


 
protectionScope
Array of strings (EEntraIdTenantResource) 
Array of tenant protection scopes.


Items Enum: "Users" "Groups" "AdministrativeUnits" "Roles" "Applications" "Logs" "ConditionalAccessPolicies" "IntunePolicies" "OrgContacts" "Devices"  
Responses 
201
An Infrastructure session has been created to add the tenant. 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/inventory/entraId/tenants
Request samples 
application/json
{
  • "azureTenantId": "00000000-0000-0000-0000-000000000000",
  • "cacheRepositoryId": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
  • "creationMode": "NewAccount",
  • "description": "Tenant 1",
  • "region": "Global",
  • "newAccount": {
    },
  • "protectionScope": [
    ]
}
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 Microsoft Entra ID Tenant
The HTTP GET request to the /api/v1/inventory/entraId/tenants/{id} endpoint gets a Microsoft Entra ID tenant 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> 
ID of the Microsoft Entra ID tenant. To get the ID, run the Get All Microsoft Entra ID Tenants 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/inventory/entraId/tenants/{id}
Request samples 
Response samples 
application/json
{
  • "region": "Global",
  • "id": "a1401206-5c01-4586-aa81-573aeb027b6d",
  • "azureTenantId": "00000000-0000-0000-0000-000000000000",
  • "description": "Tenant 1",
  • "cacheRepositoryId": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
  • "authentication": {
    },
  • "protectionScope": [
    ],
  • "name": "Organization Tenant",
  • "credentialsType": "Secret"
}
Edit Microsoft Entra ID Tenant
The HTTP PUT request to the /api/v1/inventory/entraId/tenants/{id} endpoint edits a Microsoft Entra ID tenant that has the specified id.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the Microsoft Entra ID tenant. To get the ID, run the Get All Microsoft Entra ID Tenants 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
id
required
string <uuid> 
Tenant ID assigned by Veeam Backup & Replication.


 
cacheRepositoryId
required
string <uuid> 
ID of a backup repository that is used as a cache repository for the tenant.


 
azureTenantId
string <uuid> 
Tenant ID assigned by Microsoft Entra ID.


 
description
string
Tenant description.


 
region
string (EAzureRegionType) 
Microsoft Azure region.


 Enum: "China" "Global" "Government"  
object (EntraIDTenantAuthenticationModel) 
Authentication settings.


 
protectionScope
Array of strings (EEntraIdTenantResource) 
Array of tenant protection scopes.


Items Enum: "Users" "Groups" "AdministrativeUnits" "Roles" "Applications" "Logs" "ConditionalAccessPolicies" "IntunePolicies" "OrgContacts" "Devices"  
name
string
Tenant name.


 
credentialsType
string (EEntraIdTenantCredentialsType) 
Credentials type.


 Enum: "Secret" "Certificate"  
Responses 
200
Microsoft Entra ID tenant has 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/inventory/entraId/tenants/{id}
Request samples 
application/json
{
  • "region": "Global",
  • "id": "a1401206-5c01-4586-aa81-573aeb027b6d",
  • "azureTenantId": "00000000-0000-0000-0000-000000000000",
  • "description": "Tenant 1",
  • "cacheRepositoryId": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
  • "authentication": {
    },
  • "protectionScope": [
    ],
  • "name": "Organization Tenant",
  • "credentialsType": "Secret"
}
Response samples 
application/json
{
  • "region": "Global",
  • "id": "a1401206-5c01-4586-aa81-573aeb027b6d",
  • "azureTenantId": "00000000-0000-0000-0000-000000000000",
  • "description": "Tenant 1",
  • "cacheRepositoryId": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
  • "authentication": {
    },
  • "protectionScope": [
    ],
  • "name": "Organization Tenant",
  • "credentialsType": "Secret"
}
Remove Microsoft Entra ID Tenant
The HTTP DELETE request to the /api/v1/inventory/entraId/tenants/{id} endpoint removes a Microsoft Entra ID tenant that has the specified id from the backup infrastructure.
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the Microsoft Entra ID tenant. To get the ID, run the Get All Microsoft Entra ID Tenants 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 tenant. 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/inventory/entraId/tenants/{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
}
Get Active Directory Objects from Domain
The HTTP GET request to the /api/v1/inventory/activeDirectory/domains/{id} endpoint gets an array of objects from the Active Directory domain that has the specified id. 
Available to: Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of Active Directory domain. To get the ID, run the Get Active Directory Domains request.


 
query Parameters
skip
integer <int32> 
Number of Active Directory objects to skip.


 
limit
integer <int32> 
 Default:  200
Maximum number of Active Directory objects to return.


 
orderColumn
string (EADObjectFiltersOrderColumn) 
Sorts Active Directory objects by one of the parameters.


 Enum: "FullName" "Type"  
orderAsc
boolean
Sorts Active Directory objects in ascending order by the orderColumn parameter.


 
fullNameFilter
string
Filters Active Directory objects by the fullNameFilter pattern. The pattern can match any Active Directory domain parameter. To substitute one or more characters, use the asterisk (*) character at the beginning and/or at the end.


 
typeFilter
string
Filters Active Directory objects by type.


 
parentIdFilter
string <uuid> 
Filters Active Directory objects by parent object ID. Returns only direct children of the specified parent.


 
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/inventory/activeDirectory/domains/{id}
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Available Disk Slots for Platform
The HTTP GET request to the /api/v1/inventory/platforms/{platform}/diskSlots endpoint gets an array of available disk slots for selected platform. 
Available to: Backup Administrator, Backup Operator, Restore Operator. Also available to custom roles that have backup or restore permissions.


SecurityBearer 
Request 
path Parameters
platform
required
string (EPlatformType) 
Platform for which available disk slots will be returned.


 Enum: "VMware" "HyperV" "CloudDirector" "WindowsPhysical" "LinuxPhysical" "Tape" "CustomPlatform" "EntraID" "UnstructuredData" "Test" "MongoDb" "Iris" "AWSEC2" "AzureCompute" "GCE" "Nutanix" "Proxmox" "LinuxPhysicalPpc" "ApplicationBackupRepository"  
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/inventory/platforms/{platform}/diskSlots
Request samples 
Response samples 
application/json
{
  • "diskSlots": [
    ]
}