- About Veeam Backup & Replication REST API
- Overview
- How To
- Changelog
- Login
- 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
- 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
- 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
- Service
- Services
- Connection
- Cloud Browser
- Inventory Browser
- getGet All VMware vSphere Servers
- getGet VMware vSphere Server Objects
- postGet All Servers
- postGet Inventory Objects
- postRescan Inventory Objects
- 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
- Traffic Rules
- General Options
- 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
- Managed Servers
- 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
- Proxies
- WAN Accelerators
- Jobs
- Backups
- Backup Objects
- Restore Points
- Backup Browsers
- getGet All File Restore Mount Points
- getGet File Restore Mount Point
- 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
- 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
- Restore
- getGet All VM Mount Points
- postStart Instant Recovery
- getGet VM Mount Point
- postStop VM Publishing
- postStart VM Migration
- postRestore Entire VMware vSphere VM
- postRestore Entire VMware Cloud Director VM
- getGet All FCD Mounts
- 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
- postUnmount Microsoft Entra ID Tenant
- postStart Microsoft Entra ID Audit Log Restore
- postUnmount Microsoft Entra ID Audit Logs
- Data Integration API
- Tasks
- Replicas
- Replica Restore Points
- Failover
- Failback
- Sessions
- Agents
- 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
Inventory browser allows you to perform the following operations:
- 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 and VMware Cloud Director objects only.
- Manage Microsoft Entra ID tenants
Get All VMware vSphere ServersDeprecated
The HTTP GET request to the /api/v1/inventory/vmware/hosts
path allows you to get an array of all VMware vSphere servers added to the backup infrastructure.
Available to: Veeam Backup Administrator.
query Parameters
skip | integer <int32> Number of VMware vSphere servers to skip. |
limit | integer <int32> Maximum number of VMware vSphere servers to return. |
orderColumn | string (EViRootFiltersOrderColumn) Sorts VMware vSphere servers by one of the VMware vSphere server parameters. |
orderAsc | boolean If |
nameFilter | string Filters VMware vSphere servers by the |
header Parameters
x-api-version required | string Default: 1.2-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": [
- {
- "inventoryObject": {
- "type": "vCenterServer",
- "hostName": "vcenter01.tech01.local",
- "name": "vcenter01.tech01.local",
- "objectId": "d766a026-a7a7-4d6e-add0-9599a291394f"
}, - "size": "N/A"
}, - {
- "inventoryObject": {
- "type": "vCenterServer",
- "hostName": "vcenter02.tech02.local",
- "name": "vcenter02.tech02.local",
- "objectId": "bd49ae5e-d5ec-4013-8ffa-c91beadce052"
}, - "size": "N/A"
}
], - "pagination": {
- "total": 2,
- "count": 2,
- "skip": 0,
- "limit": 200
}
}
Get VMware vSphere Server ObjectsDeprecated
The HTTP GET request to the /api/v1/inventory/vmware/hosts/{name}
path allows you to get an array of virtual infrastructure objects of the VMware vSphere server that has the specified name
.
Available to: Veeam Backup Administrator.
path Parameters
name required | string Name of the VMware vSphere server. |
query Parameters
skip | integer <int32> Number of objects to skip. |
limit | integer <int32> Maximum number of objects to return. |
orderColumn | string (EvCentersInventoryFiltersOrderColumn) Sorts objects by one of the object parameters. |
orderAsc | boolean If |
objectIdFilter | string Filters objects by object ID. |
hierarchyTypeFilter | string (EHierarchyType) Filters objects by hierarchy type. |
nameFilter | string Filters objects by the |
typeFilter | string (EVmwareInventoryType) Filters objects by virtual infrastructure type. |
parentContainerNameFilter | string Filters objects by name of the parent container. |
header Parameters
x-api-version required | string Default: 1.2-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
{- "data": [
- {
- "inventoryObject": {
- "type": "Datacenter",
- "hostName": "vcenter01.tech.local",
- "name": "Prague",
- "objectId": "datacenter-42371"
}, - "size": "N/A"
}, - {
- "inventoryObject": {
- "type": "Folder",
- "hostName": "vcenter01.tech.local",
- "name": "Templates",
- "objectId": "group-h42373"
}, - "size": "N/A"
}, - {
- "inventoryObject": {
- "type": "Host",
- "hostName": "vcenter01.tech.local",
- "name": "esx03.tech.local",
- "objectId": "host-42428"
}, - "size": "N/A"
}, - {
- "inventoryObject": {
- "type": "ResourcePool",
- "hostName": "vcenter01.tech.local",
- "name": "Services",
- "objectId": "resgroup-65867"
}, - "size": "N/A"
}, - {
- "inventoryObject": {
- "type": "VirtualMachine",
- "hostName": "vcenter01.tech.local",
- "name": "winsrv01",
- "objectId": "vm-62230"
}, - "size": "220 GB"
}
], - "pagination": {
- "total": 5,
- "count": 5,
- "skip": 0,
- "limit": 200
}
}
Get All Servers
The HTTP POST request to the /api/v1/inventory
path allows you to get an array of all servers and hosts added to the backup infrastructure.
To filter servers by type, use the following possible values: VCenterServer, Folder, Host, CloudDirectorServer. For details, see request samples.
Available to: Veeam Backup Administrator.
header Parameters
x-api-version required | string Default: 1.2-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/json
object (PaginationFilter) Pagination settings. | |
object (FilterExpressionModel) Filter settings. | |
object (SortExpressionModel) Sorting settings. | |
hierarchyType | string Hierarchy type. Possible values:
|
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.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "filter": {
- "type": "GroupExpression",
- "operation": "or",
- "items": [
- {
- "type": "PredicateExpression",
- "operation": "endsWith",
- "property": "hostName",
- "value": "tech02.local"
}, - {
- "type": "PredicateExpression",
- "operation": "endsWith",
- "property": "hostName",
- "value": "tech.local"
}
]
}, - "sorting": {
- "property": "name",
- "direction": "descending"
}
}
- 200
- 401
- 403
- 500
{- "data": [
- {
- "type": "vCenterServer",
- "hostName": "vcenter01.tech.local",
- "name": "vcenter01.tech.local",
- "objectId": "b9faa59e-c6cd-44ed-8496-1b429a8f9aca",
- "urn": "vc:vcenter01.tech.local",
- "platform": "VMware",
- "size": "N/A"
}, - {
- "type": "CloudDirectorServer",
- "hostName": "prgclouddirector02.tech02.local",
- "name": "prgclouddirector02.tech02.local",
- "objectId": null,
- "urn": "vcdsystem:prgclouddirector02.tech02.local",
- "platform": "CloudDirector",
- "size": "N/A"
}
], - "pagination": {
- "total": 2,
- "count": 2,
- "skip": 0,
- "limit": 200
}, - "hierarchyType": null
}
Get Inventory Objects
The HTTP POST request to the /api/v1/inventory/{hostname}
path allows you to get an array of inventory objects of a virtualization server (or host) that has the specified hostname
.
Available to: Veeam Backup Administrator.
path Parameters
hostname required | string Name of the server. |
query Parameters
resetCache | boolean If |
header Parameters
x-api-version required | string Default: 1.2-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/json
object (PaginationFilter) Pagination settings. | |
object (FilterExpressionModel) Filter settings. | |
object (SortExpressionModel) Sorting settings. | |
hierarchyType | string Hierarchy type. Possible values:
|
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.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "filter": {
- "type": "GroupExpression",
- "operation": "and",
- "items": [
- {
- "type": "GroupExpression",
- "operation": "and",
- "items": [
- {
- "type": "PredicateExpression",
- "operation": "greaterThan",
- "property": "Size",
- "value": "10 Mb"
}, - {
- "type": "PredicateExpression",
- "operation": "lessThan",
- "property": "Size",
- "value": "100 Mb"
}
]
}, - {
- "type": "PredicateExpression",
- "operation": "in",
- "property": "Type",
- "value": "VirtualMachine"
}, - {
- "type": "PredicateExpression",
- "operation": "Contains",
- "property": "urn",
- "value": "hostsystem:host-08;"
}
]
}, - "sorting": {
- "property": "Size",
- "direction": "descending"
}
}
- 200
- 401
- 403
- 404
- 500
{- "data": [
- {
- "platform": "VMware",
- "size": "string",
- "hostName": "string",
- "name": "string",
- "type": "Unknown",
- "objectId": "string",
- "urn": "string"
}
], - "pagination": {
- "total": 0,
- "count": 0,
- "skip": 0,
- "limit": 0
}, - "hierarchyType": "string"
}
Rescan Inventory Objects
The HTTP POST request to the /api/v1/inventory/{hostname}/rescan
path allows you to rescan inventory objects of a virtualization server (or host) that has the specified hostname
.
Available to: Veeam Backup Administrator.
path Parameters
hostname required | string Name of the server. |
header Parameters
x-api-version required | string Default: 1.2-rev0 Version and revision of the client REST API. Must be in the following format: |
A HierarchyRescan
task has been started. To check the progress, track the task 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
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "Common",
- "name": "string",
- "state": "Starting",
- "progressPercent": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "result": "None",
- "additionalInfo": {
- "message": "string",
- "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
- "resourceReference": "string"
}
}
Get All Unstructured Data Servers
The HTTP GET request to the /api/v1/unstructuredDataServers
path allows you to get an array of unstructured data servers available on a backup server.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Tape Operator, Veeam Backup Viewer.
query Parameters
skip | integer <int32> Number of unstructured data servers to skip. |
limit | integer <int32> Maximum number of unstructured data servers to return. |
orderColumn | string (EUnstructuredDataServersFiltersOrderColumn) Sorts unstructured data servers by one of the Unstructured Data Servers parameters. |
orderAsc | boolean If |
nameFilter | string Filters unstructured data servers by the |
header Parameters
x-api-version required | string Default: 1.2-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": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FileServer",
- "name": "string",
- "hostId": "70e3fb2d-1cb6-4dbc-ab8d-fa7209aca5dd",
- "processing": {
- "cacheRepositoryId": "6df20968-3080-420e-8a68-c1c515dacc9d",
- "backupIOControlLevel": "Lowest"
}
}
], - "pagination": {
- "total": 0,
- "count": 0,
- "skip": 0,
- "limit": 0
}
}
Get Unstructured Data Servers
The HTTP GET request to the /api/v1/inventory/unstructuredDataServers/{id}
path allows you to get an unstructured data server that has the specified id
.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Tape Operator, Veeam Backup Viewer.
path Parameters
id required | string <uuid> ID of the unstructured data server. |
header Parameters
x-api-version required | string Default: 1.2-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
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "FileServer",
- "name": "string",
- "hostId": "70e3fb2d-1cb6-4dbc-ab8d-fa7209aca5dd",
- "processing": {
- "cacheRepositoryId": "6df20968-3080-420e-8a68-c1c515dacc9d",
- "backupIOControlLevel": "Lowest"
}
}
Get All Microsoft Entra ID Tenants
The HTTP GET request to the /api/v1/inventory/entraId/tenants
path allows you to get an array of all Microsoft Entra ID tenants added to the backup server.
Available to: Veeam Backup Administrator, Veeam Backup Operator Veeam Restore Operator, Veeam Tape Operator, Veeam Backup Viewer.
query Parameters
skip | integer <int32> Number of Microsoft Entra ID tenants to skip. |
limit | integer <int32> Maximum number of Microsoft Entra ID tenants to return. |
orderColumn | string (EEntraIDTenantsFiltersOrderColumn) Sorts Microsoft Entra ID tenants by one of the tenant parameters. |
orderAsc | boolean If |
nameFilter | string Filters Microsoft Entra ID tenants by the |
header Parameters
x-api-version required | string Default: 1.2-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": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "azureTenantId": "6ac2a4cb-d64b-453b-b876-903c6cd67915",
- "description": "string",
- "cacheRepositoryId": "6df20968-3080-420e-8a68-c1c515dacc9d",
- "region": "China",
- "authentication": {
- "applicationId": "string",
- "secret": "string",
- "certificate": {
- "certificate": "string",
- "formatType": "pfx",
- "password": "string"
}
}
}
], - "pagination": {
- "total": 0,
- "count": 0,
- "skip": 0,
- "limit": 0
}
}
Add Microsoft Entra ID Tenant
The HTTP POST request to the /api/v1/inventory/entraId/tenants
path allows you to add 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:
- To generate a code, use the Get Microsoft Entra ID Verification Code request.
- To register the new application, use the Register Microsoft Entra ID Application request.
Available to: Veeam Backup Administrator.
header Parameters
x-api-version required | string Default: 1.2-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonrequired
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. |
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. |
object (EntraIDTenantExistingAccountSpec) Existing Microsoft Entra ID app registration. | |
object (EntraIDTenantNewAccountSpec) New Microsoft Entra ID app registration. |
An Infrastructure
session has been created to add the tenant. 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
{- "azureTenantId": "00000000-0000-0000-0000-000000000000",
- "cacheRepositoryId": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
- "creationMode": "newAccount",
- "description": "Tenant 1",
- "region": "Global",
- "newAccount": {
- "verificationCode": "D8Q2S9KU3"
}
}
- 201
- 400
- 401
- 403
- 500
{- "sessionType": "Infrastructure",
- "state": "Working",
- "id": "59f85a1e-2016-4d08-aea5-2676a03d548c",
- "name": "Infrastructure Item Saving",
- "jobId": "59f85a1e-2016-4d08-aea5-2676a03d548c",
- "creationTime": "2024-01-28T19:48:43.117+01:00",
- "endTime": null,
- "progressPercent": 0,
- "result": null,
- "resourceId": null,
- "resourceReference": null,
- "parentSessionId": null,
- "usn": 0
}
Get Microsoft Entra ID Tenant
The HTTP GET request to the /api/v1/entraId/tenants/{id}
path allows you to get a Microsoft Entra ID tenant that has the specified id
.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Tape Operator, Veeam Backup Viewer.
path Parameters
id required | string <uuid> ID of the Microsoft Entra ID tenant. |
header Parameters
x-api-version required | string Default: 1.2-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
{- "region": "Global",
- "id": "a1401206-5c01-4586-aa81-573aeb027b6d",
- "azureTenantId": "00000000-0000-0000-0000-000000000000",
- "description": "Tenant 1",
- "cacheRepositoryId": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
- "authentication": {
- "applicationId": "00000000-0000-0000-0000-000000000000",
- "secret": null,
- "certificate": null
}
}
Edit Microsoft Entra ID Tenant
The HTTP PUT request to the /api/v1/entraId/tenants/{id}
path allows you to edit a Microsoft Entra ID tenant that has the specified id
.
Available to: Veeam Backup Administrator.
path Parameters
id required | string <uuid> ID of the Microsoft Entra ID tenant. |
header Parameters
x-api-version required | string Default: 1.2-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonrequired
id required | string <uuid> Tenant ID assigned by Veeam Backup & Replication. |
azureTenantId | string <uuid> Tenant ID assigned by Microsoft Entra ID. |
description | string Tenant description. |
cacheRepositoryId | string <uuid> ID of a backup repository that is used as a cache repository for the tenant. |
region | string (EAzureRegionType) Microsoft Azure region. |
object (EntraIDTenantAuthenticationModel) Authentication settings. |
Microsoft Entra ID tenant has 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
{- "region": "Global",
- "id": "a1401206-5c01-4586-aa81-573aeb027b6d",
- "azureTenantId": "00000000-0000-0000-0000-000000000000",
- "description": "Tenant 1",
- "cacheRepositoryId": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
- "authentication": {
- "applicationId": "00000000-0000-0000-0000-000000000000",
- "secret": null,
- "certificate": null
}
}
- 200
- 400
- 401
- 403
- 404
- 500
{- "region": "Global",
- "id": "a1401206-5c01-4586-aa81-573aeb027b6d",
- "azureTenantId": "00000000-0000-0000-0000-000000000000",
- "description": "Tenant 1",
- "cacheRepositoryId": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
- "authentication": {
- "applicationId": "00000000-0000-0000-0000-000000000000",
- "secret": null,
- "certificate": null
}
}
Remove Microsoft Entra ID Tenant
The HTTP DELETE request to the /api/v1/entraId/tenants/{id}
path allows you to remove a Microsoft Entra ID tenant that has the specified id
from the backup infrastructure.
Available to: Veeam Backup Administrator.
path Parameters
id required | string <uuid> ID of the Microsoft Entra ID tenant. |
header Parameters
x-api-version required | string Default: 1.2-rev0 Version and revision of the client REST API. Must be in the following format: |
An InfrastructureItemDeletion
session has been created to remove the tenant. 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": "2024-01-28T20:21:08.81+01:00",
- "endTime": null,
- "progressPercent": 0,
- "result": null,
- "resourceId": null,
- "resourceReference": null,
- "parentSessionId": null,
- "usn": 0
}