Veeam Backup & Replication 13
REST API Reference
Related documents

Data Integration API

The Data Integration API section defines paths and operations for publishing disks from backups and snapshot replicas.

Get All Disk Publishing Mount Points

The HTTP GET request to the /api/v1/dataIntegration path allows you to get an array of mount points for disk publishing operations.

Available to: Veeam Backup Administrator, Veeam Restore Operator.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of mount points to skip.

limit
integer <int32>
Default: 200

Maximum number of mount points to return.

orderColumn
string (EBackupContentMountsFiltersOrderColumn)

Sorts mount points by one of the mount point parameters.

Value: "state"
orderAsc
boolean

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

stateFilter
string (EBackupContentMountState)

Filters mount points by mount point state.

Enum: "Mounted" "MountFailed" "Mounting" "Unmounted" "UnmountFailed" "Unmounting"
modeFilter
string (EBackupContentDiskPublishMode)

Filters mount points by mount mode.

Enum: "Fuse" "ISCSI"
header Parameters
x-api-version
required
string
Default: 1.3-rev0

Version and revision of the client REST API. Must be in the following format: <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/dataIntegration
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Start Disk Publishing
The HTTP POST request to the /api/v1/dataIntegration/publish path allows you to start a disk publishing session.
Available to: Veeam Backup Administrator, Veeam Restore Operator.


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


 
Request Body schema: application/json
required
restorePointId
required
string <uuid> 
Restore point ID. You can use restore points from backups and snapshot replicas.


 
type
required
string (EPublishBackupContentModeType) 
Disk publishing mount mode.
  • ISCSITarget — Automatic iSCSI mode. Use this mode if you want Veeam Backup & Replication to automatically configure the iSCSI initiator, start an iSCSI session and allow the specified target Microsoft Windows server to access disk content.
    •  
  • ISCSIWindowsMount — Manual iSCSI mode. Use this mode if you want to manually start an iSCSI session from any Microsoft Windows server that has access to the iSCSI target server (mount server).
    •  
  • FUSELinuxMount — FUSE mode. Use this mode to allow the specified target Linux or Unix server to access disk content.


 
allowedIps
required
Array of strings
Array of IP addresses of target servers that are allowed to access the iSCSI target server (mount server).


 
diskNames
Array of strings
Array of disk names.


 
mountHostId
string <uuid> 
Mount server ID.


 
Responses 
201
A PublishBackupContentViaMount session has been started to publish disks. To check the progress, track the session state.


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


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


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


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


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


post/api/v1/dataIntegration/publish
Request samples 
application/json
{
  • "restorePointId": "58d8ce8c-2e04-47c7-8f11-a17875b1eed3",
  • "type": "FUSELinuxMount",
  • "targetServerName": "linbase03",
  • "targetServerCredentialsId": "27f962c5-86d6-4a7c-b450-5faa99b08d03"
}
Response samples 
application/json
{
  • "sessionType": "PublishBackupContentViaMount",
  • "state": "Starting",
  • "platformName": "VMware",
  • "id": "cc5de5c2-3ce4-4b67-af45-3733c3fc0a1e",
  • "name": "linbase01",
  • "jobId": "2597af5d-0645-401c-ae7c-db663c35597e",
  • "creationTime": "2024-11-15T13:01:29.905514+01:00",
  • "endTime": null,
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": null,
  • "resourceReference": null,
  • "parentSessionId": null,
  • "usn": 16087,
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Get Disk Publishing Mount Point
The HTTP GET request to the /api/v1/dataIntegration/{mountId} path allows you to get a disk publishing mount point that has the specified mountID.
Available to: Veeam Backup Administrator, Veeam Restore Operator.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <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/dataIntegration/{mountId}
Request samples 
Response samples 
application/json
{
  • "mountState": "Mounted",
  • "id": "bce89e03-9269-4cb0-aa49-c8b04d4273d5",
  • "initiatorName": "SRV99\\Administrator",
  • "backupId": "bdc74451-8719-4a66-9791-21a4bbd2d048",
  • "backupName": "Backup Job 1 - linbase01",
  • "restorePointId": "170bcae5-f2c4-4547-972e-15349aa04609",
  • "restorePointName": "linbase01",
  • "info": {
    }
}
Stop Disk Publishing
The HTTP POST request to the /api/v1/dataIntegration/{mountId}/unpublish path allows you to stop publishing a mount point that has the specified mountID. 
Available to: Veeam Backup Administrator, Veeam Restore Operator.


SecurityBearer 
Request 
path Parameters
mountId
required
string <uuid> 
Mount point ID.


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


 
Responses 
200
A PublishBackupContentViaMount session has been started to unpublish disks. To check the progress, track the session state.


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


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


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


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


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


post/api/v1/dataIntegration/{mountId}/unpublish
Request samples 
Response samples 
application/json
{
  • "sessionType": "PublishBackupContentViaMount",
  • "state": "Working",
  • "platformName": null,
  • "id": "cc5de5c2-3ce4-4b67-af45-3733c3fc0a1e",
  • "name": "linbase01",
  • "jobId": "2597af5d-0645-401c-ae7c-db663c35597e",
  • "creationTime": "2024-11-15T13:01:29.905514+01:00",
  • "endTime": null,
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "cc5de5c2-3ce4-4b67-af45-3733c3fc0a1e",
  • "resourceReference": null,
  • "parentSessionId": null,
  • "usn": 0,
  • "platformId": null
}