Veeam Backup & Replication 13
REST API Reference
Related documents

Repositories

The Repositories section defines paths and operations for managing backup repositories.

NOTE
In this version, the REST API supports the following storage types: direct attached storages (Microsoft Windows and Linux servers), network attached storages (SMB and NFS shares), object storages and Veeam Data Cloud Vault repositories. For details on how to add an object storage repository, see Adding Object Storage Repository.

Get All Repositories

The HTTP GET request to the /api/v1/backupInfrastructure/repositories path allows you to get an array of all backup repositories that are added to the backup infrastructure.

Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of repositories to skip.

limit
integer <int32>
Default: 200

Maximum number of repositories to return.

orderColumn
string (ERepositoryFiltersOrderColumn)

Sorts repositories by one of the repository parameters.

Enum: "Name" "Description" "Type" "Host" "Path"
orderAsc
boolean

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

nameFilter
string

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

typeFilter
Array of strings (ERepositoryType)

Filters repositories by repository type.

Items Enum: "WinLocal" "LinuxLocal" "Smb" "Nfs" "AzureBlob" "AzureDataBox" "AzureArchive" "AmazonS3" "AmazonSnowballEdge" "AmazonS3Glacier" "S3Compatible" "GoogleCloud" "IBMCloud" "ExtendableRepository" "DDBoost" "ExaGrid" "HPStoreOnceIntegration" "Quantum" "WasabiCloud" "LinuxHardened" "Infinidat" "Fujitsu" "VeeamDataCloudVault" "S3GlacierCompatible" "SmartObjectS3" "Cloud" "HPStoreOnce" "Foreign" "SanSnapshotOnly" "Tape" "AmazonS3External" "AzureStorageExternal" "PlatformServiceExternal" "GoogleCloudStorageExternal" "PlatformServiceVmbApi" "AmazonS3GlacierExternal" "GoogleArchiveStorageExternal" "AzureArchiveStorageExternal" "HPStoreOnceCloudBank" "VeeamVault" "ElevenElevenS3" "AbrVirtual"
hostIdFilter
string <uuid>

Filters repositories by ID of the backup server.

pathFilter
string

Filters repositories by path to the folder where backup files are stored.

vmbApiFilter
string

Filters repositories by VM Backup API parameters converted to the base64 string. To obtain the string, call the GetApiProductInfoString method of VM Backup API.

vmbApiPlatform
string <uuid>

Filters repositories by ID of a platform that you use to communicate with VM Backup API.

excludeExtents
boolean

If true, filters out repositories that are a part of an extent for Scale-Out repositories.

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.

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/backupInfrastructure/repositories
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Repository
The HTTP POST request to the /api/v1/backupInfrastructure/repositories path allows you to add a repository to the backup infrastructure.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
query Parameters
overwriteOwner
boolean
If true, the owner of the repository will be overwritten.


 
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
description
required
string
Description of the backup repository.


 
name
required
string
Name of the backup repository.


 
type
required
string (ERepositoryType) 
Repository type.


 
hostId
required
string <uuid> 
ID of the server that is used as a backup repository.


 
required
object (MountServersSettingsModel) 
Mount server settings.


 
required
object (WindowsLocalRepositorySettingsModel) 
Repository settings.


 
uniqueId
string
Unique ID that identifies the backup repository.


 
importBackup
boolean
If true, Veeam Backup & Replication will search the repository for existing backups and import them automatically.


 
importIndex
boolean
If true, Veeam Backup & Replication will import the guest OS file system index.


 
Responses 
201
An Infrastructure session has been created to add the repository. 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/backupInfrastructure/repositories
Request samples 
application/json
{
  • "hostId": "565e7001-edf0-4724-8191-767592537016",
  • "repository": {
    },
  • "mountServer": {
    },
  • "type": "WinLocal",
  • "name": "Backup Repository 5",
  • "description": "Repository on enterprise05",
  • "uniqueId": "565e7001-edf0-4724-8191-767592537016"
}
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"
}
Rescan Repositories
The HTTP POST request to the /api/v1/backupInfrastructure/repositories/rescan path allows you to rescan an array of the specified repositories.
Available to: Veeam Backup Administrator.


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
repositoryIds
required
Array of strings <uuid> 
Array of repository IDs to rescan.


 
Responses 
201
A ConfigurationResynchronize session has been created to rescan the repositories. 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/backupInfrastructure/repositories/rescan
Request samples 
application/json
{
  • "repositoryIds": [
    ]
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
  • "initiatedBy": "string"
}
Get All Repository States
The HTTP GET request to the /api/v1/backupInfrastructure/repositories/states path allows you to get an array of all repository states. The states include repository location and brief statistics, such as repository capacity, free and used space.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.


SecurityBearer 
Request 
query Parameters
skip
integer <int32> 
Number of repository states to skip.


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


 
orderColumn
string (ERepositoryStatesFiltersOrderColumn) 
Sorts repository states by one of the state parameters.


 Enum: "Name" "Type" "Host" "Path" "CapacityGB" "FreeGB" "UsedSpaceGB" "Description" "Membership"  
orderAsc
boolean
If true, sorts repository states in the ascending order by the orderColumn parameter.


 
idFilter
string <uuid> 
Filters repository states by repository ID.


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


 
typeFilter
string (ERepositoryType) 
Filters repository states by repository type.


 Enum: "WinLocal" "LinuxLocal" "Smb" "Nfs" "AzureBlob" "AzureDataBox" "AzureArchive" "AmazonS3" "AmazonSnowballEdge" "AmazonS3Glacier" "S3Compatible" "GoogleCloud" "IBMCloud" "ExtendableRepository" "DDBoost" "ExaGrid" "HPStoreOnceIntegration" "Quantum" "WasabiCloud" "LinuxHardened" "Infinidat" "Fujitsu" "VeeamDataCloudVault" "S3GlacierCompatible" "SmartObjectS3" "Cloud" "HPStoreOnce" "Foreign" "SanSnapshotOnly" "Tape" "AmazonS3External" "AzureStorageExternal" "PlatformServiceExternal" "GoogleCloudStorageExternal" "PlatformServiceVmbApi" "AmazonS3GlacierExternal" "GoogleArchiveStorageExternal" "AzureArchiveStorageExternal" "HPStoreOnceCloudBank" "VeeamVault" "ElevenElevenS3" "AbrVirtual"  
capacityFilter
number <double> 
Filters repository states by repository capacity.


 
freeSpaceFilter
number <double> 
Filters repository states by repository free space.


 
usedSpaceFilter
number <double> 
Filters repository states by repository used space.


 
isOnlineFilter
boolean
Filters repository states by repository connection status.


 
isOutOfDateFilter
boolean
If true, Veeam Backup & Replication returns only repositories with outdated components.


 
sobrIdFilter
string <uuid> 
Filters repository states by repository ID.


 
sobrExtentTypeFilter
Array of strings (EScaleOutRepositoryExtentType) 
Filters repository states based on the extent type of the scale-out backup repository.


Items Enum: "Performance" "Capacity" "Archive"  
sobrMembershipFilter
string
Filters repository states by the nameFilter pattern. The pattern can match any repository state parameter. To substitute one or more characters, use the asterisk (*) character at the beginning and/or at the end.


 
excludeExtents
boolean
Filters out repositories that are a part of an extent for scale-out backup repositories.


 
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.


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/backupInfrastructure/repositories/states
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Repository
The HTTP GET request to the /api/v1/backupInfrastructure/repositories/{id} path allows you to get a backup repository that has the specified id.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Backup repository ID. To get the ID, run the Get All Repositories 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>.


 
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/backupInfrastructure/repositories/{id}
Request samples 
Response samples 
application/json
{
  • "hostId": "25d2b2f8-ff7d-458d-a558-3ffc937d2624",
  • "repository": {
    },
  • "mountServer": {
    },
  • "type": "LinuxLocal",
  • "id": "d2f2d569-1dfe-4294-89df-d429cedffdc1",
  • "name": "Backup Repository 1",
  • "description": "Created by TECH\\sheila.d.cory",
  • "uniqueId": "D2F2D5691DFE429489DFD429CEDFFDC1"
}
Edit Repository
The HTTP PUT request to the /api/v1/backupInfrastructure/repositories/{id} path allows you to edit a backup repository that has the specified id.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Backup repository ID. To get the ID, run the Get All Repositories 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
description
required
string
Description of the backup repository.


 
id
required
string <uuid> 
Backup repository ID.


 
name
required
string
Name of the backup repository.


 
type
required
string (ERepositoryType) 
Repository type.


 
hostId
required
string <uuid> 
ID of the server that is used as a backup repository.


 
required
object (MountServersSettingsModel) 
Mount server settings.


 
required
object (WindowsLocalRepositorySettingsModel) 
Repository settings.


 
uniqueId
string
Unique ID that identifies the backup repository.


 
Responses 
201
An Infrastructure session has been created to edit the repository. 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.


put/api/v1/backupInfrastructure/repositories/{id}
Request samples 
application/json
{
  • "hostId": "25d2b2f8-ff7d-458d-a558-3ffc937d2624",
  • "repository": {
    },
  • "mountServer": {
    },
  • "type": "LinuxLocal",
  • "id": "d2f2d569-1dfe-4294-89df-d429cedffdc1",
  • "name": "Backup Repository 1",
  • "description": "Created by TECH\\sheila.d.cory",
  • "uniqueId": "D2F2D5691DFE429489DFD429CEDFFDC1"
}
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"
}
Remove Repository
The HTTP DELETE request to the /api/v1/backupInfrastructure/repositories/{id} path allows you to remove a backup repository that has the specified id from the backup infrastructure.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Backup repository ID. To get the ID, run the Get All Repositories request.


 
query Parameters
deleteBackups
boolean
If true, Veeam Backup & Replication will remove backup files.


 
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 
204
Repository has been removed.


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/backupInfrastructure/repositories/{id}
Request samples 
Response samples 
application/json
{ }
Get All Scale-Out Backup Repositories
The HTTP GET request to the /api/v1/backupInfrastructure/scaleOutRepositories path allows you to get an array of all scale-out backup repositories that are added to the backup infrastructure.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.


SecurityBearer 
Request 
query Parameters
skip
integer <int32> 
Number of repositories to skip.


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


 
orderColumn
string (EScaleOutRepositoryFiltersOrderColumn) 
Sorts repositories by one of the repository parameters.


 Enum: "Name" "Description" "Type" "Host" "Path" "EncryptionState"  
orderAsc
boolean
If true, sorts repositories in the ascending order by the orderColumn parameter.


 
nameFilter
string
Filters repositories by the nameFilter pattern. The pattern can match any repository 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-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.


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/backupInfrastructure/scaleOutRepositories
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Scale-Out Backup Repository
The HTTP POST request to the /api/v1/backupInfrastructure/scaleOutRepositories path allows you to add a scale-out backup repository to the backup infrastructure.
 Available to: Veeam Backup Administrator.


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
name
required
string
Name of the scale-out backup repository.


 
description
required
string
Description of the scale-out backup repository.


 
required
object (PerformanceTierSpec) 
Performance tier settings.


 
uniqueId
string
Unique ID assigned to the scale-out backup repository.


 
object (PlacementPolicyModel) 
Backup file placement policy.


 
object (CapacityTierModel) 
Capacity tier.


 
object (ArchiveTierModel) 
Archive tier.


 
Responses 
201
An Infrastructure session has been created to add the repository. 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/backupInfrastructure/scaleOutRepositories
Request samples 
application/json
{
  • "name": "string",
  • "description": "string",
  • "uniqueId": "string",
  • "performanceTier": {
    },
  • "placementPolicy": {
    },
  • "capacityTier": {
    },
  • "archiveTier": {
    }
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
  • "initiatedBy": "string"
}
Get Scale-Out Backup Repository
The HTTP GET request to the /api/v1/backupInfrastructure/scaleOutRepositories/{id} path allows you to get a scale-out backup repository that has the specified id.
 Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the scale-out backup repository. To get the ID, run the Get All Scale-Out Backup Repositories 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>.


 
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/backupInfrastructure/scaleOutRepositories/{id}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "uniqueId": "string",
  • "performanceTier": {
    },
  • "placementPolicy": {
    },
  • "capacityTier": {
    },
  • "archiveTier": {
    }
}
Edit Scale-Out Backup Repository
The HTTP PUT request to the /api/v1/backupInfrastructure/scaleOutRepositories/{id} path allows you to edit a scale-out backup repository that has the specified id.
 Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the scale-out backup repository. To get the ID, run the Get All Scale-Out Backup Repositories 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
id
required
string <uuid> 
ID of the scale-out backup repository.


 
name
required
string
Name of the scale-out backup repository.


 
description
required
string
Description of the scale-out backup repository.


 
required
object (PerformanceTierModel) 
Performance tier.


 
uniqueId
string
Unique ID assigned to the scale-out backup repository.


 
object (PlacementPolicyModel) 
Backup file placement policy.


 
object (CapacityTierModel) 
Capacity tier.


 
object (ArchiveTierModel) 
Archive tier.


 
Responses 
201
An Infrastructure session has been created to edit the scale-out backup repository. 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.


put/api/v1/backupInfrastructure/scaleOutRepositories/{id}
Request samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "uniqueId": "string",
  • "performanceTier": {
    },
  • "placementPolicy": {
    },
  • "capacityTier": {
    },
  • "archiveTier": {
    }
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
  • "initiatedBy": "string"
}
Remove Scale-Out Backup Repository
The HTTP DELETE request to the /api/v1/backupInfrastructure/scaleOutRepositories/{id} path allows you to remove a scale-out backup repository that has the specified id.
 Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the scale-out backup repository. To get the ID, run the Get All Scale-Out Backup Repositories request.


 
query Parameters
deleteBackups
boolean
If true, Veeam Backup & Replication will remove backup files.


 
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 
204
Scale-out backup repository has been removed.


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/backupInfrastructure/scaleOutRepositories/{id}
Request samples 
Response samples 
application/json
{ }
Enable Sealed Mode
The HTTP POST request to the /api/v1/backupInfrastructure/scaleOutRepositories/{id}/enableSealedMode path allows you to enable the Sealed mode for specified extents of a scale-out backup repository that has the specified id.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the scale-out backup repository. To get the ID, run the Get All Scale-Out Backup Repositories 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
repositoryIds
required
Array of strings <uuid> 
Array of repository IDs added as scale-out backup repository extents.


 
Responses 
201
A RepositoryMaintenance session has been created. 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/backupInfrastructure/scaleOutRepositories/{id}/enableSealedMode
Request samples 
application/json
{
  • "repositoryIds": [
    ]
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
  • "initiatedBy": "string"
}
Disable Sealed Mode
The HTTP POST request to the /api/v1/backupInfrastructure/scaleOutRepositories/{id}/disableSealedMode path allows you to disable the Sealed mode for specified extents of a scale-out backup repository that has the specified id.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the scale-out backup repository. To get the ID, run the Get All Scale-Out Backup Repositories 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
repositoryIds
required
Array of strings <uuid> 
Array of repository IDs added as scale-out backup repository extents.


 
Responses 
201
A RepositoryMaintenance session has been created. 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/backupInfrastructure/scaleOutRepositories/{id}/disableSealedMode
Request samples 
application/json
{
  • "repositoryIds": [
    ]
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
  • "initiatedBy": "string"
}
Enable Maintenance Mode
The HTTP POST request to the /api/v1/backupInfrastructure/scaleOutRepositories/{id}/enableMaintenanceMode path allows you to enable the Maintenance mode for specified extents of a scale-out backup repository that has the specified id.
 Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the scale-out backup repository. To get the ID, run the Get All Scale-Out Backup Repositories 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
repositoryIds
required
Array of strings <uuid> 
Array of repository IDs added as scale-out backup repository extents.


 
Responses 
201
A RepositoryMaintenance session has been created. 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/backupInfrastructure/scaleOutRepositories/{id}/enableMaintenanceMode
Request samples 
application/json
{
  • "repositoryIds": [
    ]
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
  • "initiatedBy": "string"
}
Disable Maintenance Mode
The HTTP POST request to the /api/v1/backupInfrastructure/scaleOutRepositories/{id}/disableMaintenanceMode path allows you to disable the Maintenance mode for specified extents of a scale-out backup repository that has the specified id.
 Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the scale-out backup repository. To get the ID, run the Get All Scale-Out Backup Repositories 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
repositoryIds
required
Array of strings <uuid> 
Array of repository IDs added as scale-out backup repository extents.


 
Responses 
201
A RepositoryMaintenance session has been created. 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/backupInfrastructure/scaleOutRepositories/{id}/disableMaintenanceMode
Request samples 
application/json
{
  • "repositoryIds": [
    ]
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
  • "initiatedBy": "string"
}