Veeam ONE 13
REST API Reference
Related documents

Veeam Backup & Replication Infrastructure

This resource collection represents monitored Veeam Backup & Replication infrastructure.

Get Infrastructure Object Relations

Returns a collection resource representation of all objects in the Veeam Backup & Replication infrastructure and their relations.

SecurityBearer
Request
query Parameters
Offset
integer <int32>
Default: 0
Limit
integer <int32>
Default: 100
Filter
string
Sort
string
Select
string
Responses
200

Success

403

Forbidden

get/api/v2.3/vbr/objectRelations
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get Relations of Infrastructure Object
Returns a resource representation of a Veeam Backup & Replication infrastructure object with the specified ID and its relations.


SecurityBearer 
Request 
path Parameters
objectId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/objectRelations/{objectId}
Request samples 
Response samples 
application/json
{
  • "objectId": 7,
  • "objectName": "Cloud Gateways",
  • "objectType": "CloudGatewayFolder",
  • "parentId": 5,
  • "parentName": "repVBR10.tech.local",
  • "parentType": "BackupServer"
}
Get All Backup Agents
Returns a collection resource representation of all monitored Veeam backup agents.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/backupAgents
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Backup Agent
Returns a resource representation of a monitored Veeam backup agent with the specified ID.


SecurityBearer 
Request 
path Parameters
backupAgentId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/backupAgents/{backupAgentId}
Request samples 
Response samples 
application/json
{
  • "backupAgentId": 11823,
  • "backupAgentUidInVbr": "1aa5af66-bb31-41f3-9cb4-5b799535358b",
  • "backupServerId": 11782,
  • "protectionGroups": [
    ],
  • "name": "W10X64",
  • "platform": "MicrosoftWindows",
  • "operationMode": "Server",
  • "status": "Installed",
  • "version": "5.0.1.4584",
  • "ipAddresses": [
    ],
  • "lastProtectedDate": "2022-08-03T06:50:49Z",
  • "businessViewGroupIds": [
    ]
}
Get All Veeam Backup & Replication Servers
Returns a collection resource representation of all connected Veeam Backup & Replication servers.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/backupServers
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Veeam Backup & Replication Server
Returns a resource representation of a connected Veeam Backup & Replication server with the specified ID.


SecurityBearer 
Request 
path Parameters
backupServerId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/backupServers/{backupServerId}
Request samples 
Response samples 
application/json
{
  • "backupServerId": 5,
  • "enterpriseManagerId": null,
  • "name": "repVBR10.tech.local",
  • "version": "13.0.0.4913",
  • "connectionError": null,
  • "connectionState": "Connected",
  • "isConfigurationBackupEnabled": true,
  • "platform": "Linux",
  • "isCloudConnect": false,
  • "intelligentDiagnosticsEnabled": null,
  • "remediationActionsEnabled": null,
  • "lastBestPracticeCheckDate": "2023-10-24T05:00:22.504281Z",
  • "bestPracticeCheckStatus": "NotImplemented"
}
Get All Best Practices
Returns a collection resource representation of all security best practices for configuration parameters.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/backupServers/bestPractices
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Best Practices for Veeam Backup & Replication Server
Returns a collection resource representation of all security best practices for configuration parameters of a Veeam Backup & Replication server with the specified UID.


SecurityBearer 
Request 
path Parameters
backupServerId
required
integer <int64> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/backupServers/{backupServerId}/bestPractices
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get All Backup Proxies
Returns a collection resource representation of all connected backup proxies.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/backupProxies
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Backup Proxy
Returns a resource representation of a connected backup proxy with the specified ID.


SecurityBearer 
Request 
path Parameters
backupProxyId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/backupProxies/{backupProxyId}
Request samples 
Response samples 
application/json
{
  • "backupProxyId": 11704,
  • "proxyUidInVbr": "18b661c1-d9dc-4233-90a0-7e7b10dc2d09",
  • "backupServerId": 11702,
  • "name": "VMware Backup Proxy",
  • "enabled": true,
  • "version": "13.0.0.4913",
  • "type": "Vmware",
  • "state": "Ok",
  • "runningTasks": 0,
  • "maxConcurrentTasks": 2,
  • "upgradeRequired": false,
  • "transportMode": "NetworkProxy",
  • "throttlingEnabled": false
}
Get All WAN Accelerators
Returns a collection resource representation of all connected WAN accelerators.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/wanAccelerators
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get WAN Accelerator
Returns a resource representation of a connected WAN accelerator with the specified ID.


SecurityBearer 
Request 
path Parameters
wanAcceleratorId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/wanAccelerators/{wanAcceleratorId}
Request samples 
Response samples 
application/json
{
  • "wanAcceleratorId": 11871,
  • "wanAcceleratorUidInVbr": "b9fc88d2-a3ad-4435-870c-43aff381e4da",
  • "backupServerId": 11782,
  • "name": "ms-22-wan-02.tech.local",
  • "version": "13.0.0.4913",
  • "capacityBytes": 10737418240,
  • "upgradeRequired": false,
  • "state": "Ok",
  • "freeSpaceBytes": 10737418240,
  • "usedSpaceBytes": 0,
  • "cachePath": "C:\\VeeamWAN",
  • "streams": 5,
  • "trafficPort": 6165,
  • "highBandwidthMode": false
}
Get All Tape Servers
Returns a collection resource representation of all tape servers.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/tapeServers
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Tape Server
Returns a resource representation of a tape server with the specified ID.


SecurityBearer 
Request 
path Parameters
tapeServerId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/tapeServers/{tapeServerId}
Request samples 
Response samples 
application/json
{
  • "tapeServerId": 11872,
  • "tapeServerUidInVbr": "7eb26394-2425-4f2f-9714-0e87844437e2",
  • "backupServerId": 11781,
  • "name": "ES-WIN19-CC",
  • "version": "13.0.0.4913",
  • "upgradeRequired": false
}
Get All Veeam Backup Enterprise Manager Servers
Returns a collection resource representation of all Veeam Backup Enterprise Manager servers.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/enterpriseManagerServers
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Veeam Backup Enterprise Manager Server
Returns a resource representation of a Veeam Backup Enterprise Manager server with the specified ID.


SecurityBearer 
Request 
path Parameters
enterpriseManagerServerId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/enterpriseManagerServers/{enterpriseManagerServerId}
Request samples 
Response samples 
application/json
{
  • "enterpriseManagerServerId": 1430,
  • "backupServerIds": [
    ],
  • "name": "es-win19-vbr.tech.local",
  • "version": "13.0.0.4913",
  • "connectionError": null,
  • "connectionState": "Connected",
  • "platform": "Windows"
}
Get All Backup Repositories
Returns a collection resource representation of all backup repositories. Object storage repositories are not included.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/repositories
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 4
}
Get Backup Repository
Returns a resource representation of a backup repository with the specified ID. Does not return object storage repositories.


SecurityBearer 
Request 
path Parameters
repositoryId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/repositories/{repositoryId}
Request samples 
Response samples 
application/json
{
  • "repositoryId": 14,
  • "repositoryUidInVbr": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
  • "backupServerId": 5,
  • "name": "Default Backup Repository",
  • "type": "MicrosoftWindows",
  • "capacityBytes": 85372956672,
  • "freeSpaceBytes": 18513584128,
  • "runningTasks": 0,
  • "maxConcurrentTasks": 4,
  • "upgradeRequired": false,
  • "outOfSpaceInDays": 0,
  • "state": "Ok",
  • "path": "C:\\Backup",
  • "oneBackupFilePerVm": true,
  • "isReFs": true,
  • "isImmutable": false,
  • "immutabilityIntervalDays": null
}
Get All External Backup Repositories
Returns a collection resource representation of all external backup repositories.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/repositories/external
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get External Backup Repository
Returns a resource representation of an external backup respository with the specified ID.


SecurityBearer 
Request 
path Parameters
externalRepositoryId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/repositories/external/{externalRepositoryId}
Request samples 
Response samples 
application/json
{
  • "externalRepositoryId": 11755,
  • "externalRepositoryUidInVbr": "6bd43801-109f-423d-b2d8-38d322d50c54",
  • "backupServerId": 11724,
  • "name": "repogcpwin16",
  • "isDecryptionEnabled": false,
  • "region": "Data centers in the European Union",
  • "bucket": "mmfbucket",
  • "type": "GoogleCloudStorage",
  • "description": ""
}
Get All Object Storage Repositories
Returns a collection resource representation of all object storage repositories.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/repositories/objectStorages
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Object Storage Repository
Returns a resource representation of an object storage repository with the specified ID.


SecurityBearer 
Request 
path Parameters
objectStorageId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/repositories/objectStorages/{objectStorageId}
Request samples 
Response samples 
application/json
{
  • "objectStorageId": 11752,
  • "objectStorageUidInVbr": "f052d3d8-e838-4c3a-a4ff-dad91aec69fe",
  • "backupServerId": 11724,
  • "name": "Object storage repository 3 archive aws",
  • "type": "AmazonS3Glacier",
  • "runningTasks": 0,
  • "description": "Created by administrator at 10/24/2022 6:52 AM.",
  • "region": "eu-central-1",
  • "bucket": "ritech",
  • "capacityBytes": 127996724772864,
  • "usedSpaceBytes": 25973301192,
  • "consumptionLimitGb": null,
  • "isImmutable": false,
  • "immutabilityIntervalDays": null,
  • "concurrentJobsMax": -1,
  • "concurrentJobsNow": 0,
  • "infrequentAccessStorage": "Disabled"
}
Get All Scale-Out Repositories
Returns a collection resource representation of all scale-out repositories.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/scaleoutRepositories
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Scale-Out Repository
Returns a resource representation of a scale-out repository with the specified ID.


SecurityBearer 
Request 
path Parameters
scaleoutRepositoryId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/scaleoutRepositories/{scaleoutRepositoryId}
Request samples 
Response samples 
application/json
{
  • "scaleoutRepositoryId": 11863,
  • "scaleoutRepositoryUidInVbr": "6f6b3e37-8cfe-4ff9-b1dd-20b3af6832b5",
  • "backupServerId": 11782,
  • "name": "Scale-out Backup Repository",
  • "capacityBytes": 214623580160,
  • "freeSpaceBytes": 51592925184,
  • "runningTasks": 0,
  • "outOfSpaceInDays": 3652,
  • "state": "Ok",
  • "scaleoutRepositoryPolicy": "DataLocality",
  • "copyPolicy": false,
  • "movePolicyInDays": 2,
  • "archivingPolicyInDays": 2,
  • "encryptArchivedData": false
}
Get All Performance Tier Extents
Returns a collection resource representation of all performance tier extents.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/scaleoutRepositories/performanceTiers
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Performance Tier Extent
Returns a resource representation of a performance tier extent with the specified UID.


SecurityBearer 
Request 
path Parameters
extentUid
required
string <uuid> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/scaleoutRepositories/performanceTiers/{extentUid}
Request samples 
Response samples 
application/json
{
  • "extentUid": "4f902833-3171-45ce-ac0f-5e0cd4d631d4",
  • "scaleoutRepositoryId": 11991,
  • "repositoryType": "Regular",
  • "underlyingRepositoryId": 11713,
  • "isImmutable": false,
  • "immutabilityIntervalDays": null
}
Get All Archive Tier Extents
Returns a collection resource representation of all archive tier extents.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/scaleoutRepositories/archiveTiers
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Archive Tier Extent
Returns a resource representation of an archive tier extent with the specified ID.


SecurityBearer 
Request 
path Parameters
extentUid
required
string <uuid> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/scaleoutRepositories/archiveTiers/{extentUid}
Request samples 
Response samples 
application/json
{
  • "extentUid": "ce718fab-d1a0-4ad9-9fe9-84e88f47b0cf",
  • "scaleoutRepositoryId": 11863,
  • "underlyingRepositoryId": 11838,
  • "deepArchive": true,
  • "isImmutable": false
}
Get All Capacity Tier Extents
Returns a collection resource representation of all capacity tier extents.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/scaleoutRepositories/capacityTiers
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Capacity Tier Extent
Returns a resource representation of a capacity tier extent with the specified UID.


SecurityBearer 
Request 
path Parameters
extentUid
required
string <uuid> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/scaleoutRepositories/capacityTiers/{extentUid}
Request samples 
Response samples 
application/json
{
  • "extentUid": "29534995-019a-401d-bf29-93475d9e7a87",
  • "scaleoutRepositoryId": 11863,
  • "underlyingRepositoryId": 11839,
  • "isImmutable": false,
  • "immutabilityIntervalDays": null
}
Get All Connected Applications
Returns a collection resource representation of all connected applications.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/applications
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Connected Application
Returns a resource representation of a connected application with the specified ID.


SecurityBearer 
Request 
path Parameters
applicationId
required
integer <int64> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/vbr/applications/{applicationId}
Request samples 
Response samples 
application/json
{
  • "applicationId": 11723,
  • "applicationUidInVbr": "d739ddca-db5f-4554-b7f1-7b718c08527b",
  • "backupServerId": 11702,
  • "name": "pgWinOracleD",
  • "platform": "Oracle",
  • "protectionGroups": [
    ],
  • "ipAddress": "172.25.50.208",
  • "businessViewGroupIds": [
    ]
}

    
    

                                

                                    
Document updated 9/08/2025
Page content applies to build 13.0.0.5630