Veeam Service Provider Console 9.3
REST API Reference
Related documents

VDC Vault

This resource collection represents Veeam Data Cloud Vault integration support.

Get Veeam Data Cloud Vault Configuration Status

Returns a resource representation of a Veeam Data Cloud Vault configurations status.

Request
query Parameters
Array of objects or null (SelectParameter)

Returns explicitly requested properties.

header Parameters
X-Request-id
string <uuid>

Random UID that you can assign to a request for idempotence and async action progress tracking.

Note that an operation is idempotent only during 5 minute time interval.

Example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string

Version of Veeam Service Provider Console RESTful API supported by client.

Example: 3.7
Responses
200

OK

202

Request has been queued for execution.

default

All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.

get/vdcVault/configuration
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get Veeam Data Cloud Vault Registration Data
Returns a resource representation of registration data of a connected Veeam Data Cloud Vault.


Request 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/vdcVault/registration
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Register Veeam Data Cloud Vault
Completes Veeam Data Cloud Vault registration.


Request 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/vdcVault/registration
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Remove Veeam Data Cloud Vault Registration
Removes registration of a Veeam Data Cloud Vault.


Request 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


delete/vdcVault/registration
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Veeam Data Cloud Vault Subscriptions
Returns a collection resource representation of all Veeam Data Cloud Vault subscriptions.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/vdcVault/subscriptions
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Veeam Data Cloud Vault Subscription
Returns a resource representation of a Veeam Data Cloud Vault subscription with the specified UID.


Request 
path Parameters
subscriptionUid
required
string <uuid> 
Subscription UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/vdcVault/subscriptions/{subscriptionUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get All Countries of Veeam Data Cloud Vault Subscription
Returns a collection resource representation of all countries registered for a Veeam Data Cloud Vault subscription with the specified UID.


Request 
path Parameters
subscriptionUid
required
string <uuid> 
Subscription UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/vdcVault/subscriptions/{subscriptionUid}/countries
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Add Veeam Data Cloud Vault Tenant
Adds a new Veeam Data Cloud Vault tenant.


Request 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Request Body schema: application/json
required
tenantName
required
string  [ 2 .. 50 ] characters ^[a-zA-Z0-9 _-]+$
Name of a Veeam Data Cloud Vault tenant.


 
subscriptionUid
required
string <uuid> 
UID assigned to a Veeam Data Cloud Vault subscription.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/vdcVault/tenants
Request samples 
application/json
{
  • "tenantName": "alpha",
  • "subscriptionUid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get All Veeam Data Cloud Vault Tenants
Returns a collection resource representation of all Veeam Data Cloud Vault tenants.


Request 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/vdcVault/tenants
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Veeam Data Cloud Vault Tenant
Returns a resource representation of a Veeam Data Cloud Vault tenant with the specified UID.


Request 
path Parameters
tenantUid
required
string <uuid> 
Tenant UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/vdcVault/tenants/{tenantUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Map Veeam Data Cloud Tenant to Company
Creates a mapping to a company for a Veeam Data Cloud tenant with the specified UID.


Request 
path Parameters
tenantUid
required
string <uuid> 
Tenant UID.


 
query Parameters
organizationUid
required
string <uuid> 
UID of a company to which a Veeam Data Cloud tenant must be mapped.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/vdcVault/tenants/{tenantUid}/mapping
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Delete Company Mapping of Veeam Data Cloud Tenant
Deletes a mapping to a company for a Veeam Data Cloud tenant with the specified UID.


Request 
path Parameters
tenantUid
required
string <uuid> 
Tenant UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


delete/vdcVault/tenants/{tenantUid}/mapping
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Synchronize Veeam Data Cloud Vault Data
Synchronizes Veeam Data Cloud Vault data.


Request 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/vdcVault/sync
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Add Storage Vault
Adds a new storage vault.


Request 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Request Body schema: application/json
required
name
required
string  [ 3 .. 50 ] characters ^[a-zA-Z0-9 _-]+$
Name of a storage vault.


 
tenantUid
required
string <uuid> 
UID assigned to a Veeam Data Cloud Vault tenant.


 
dataCenterId
required
string
ID assigned to a data center.


 
quotaEnforced
required
boolean
Indicates whether maximum amount of available storage space is a hard quota.


 
storageQuota
integer or null <int64>   [ 1073741824 .. 1124774006935781400 ] 
Maximum amount of storage space available on storage vault.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/vdcVault/storageVaults
Request samples 
application/json
{
  • "tenantUid": "0acf6ffe-fa5f-4944-a884-e8aa5dc180b3",
  • "name": "dm-vault-temp-e7527",
  • "dataCenterId": "westeurope",
  • "storageQuota": 1073741824,
  • "quotaEnforced": false
}
Response samples 
application/json
{
  • "data": {
    }
}
Get All Storage Vaults
Returns a collection resource representation of all storage vaults.


Request 
query Parameters
tenantUid
string or null <uuid> 
Filters returned resources by UID of a Veeam Data Cloud Vault tenant to which the storage vaults are assigned.


 
expand
Array of strings (VdcStorageVaultExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Enum: "VdcVaultTenant" "VdcVaultDataCenter" "VdcVaultCountry" "VdcVaultSubscription"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/vdcVault/storageVaults
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Storage Vault
Returns a resource representation of a storage vault with the specified UID.


Request 
path Parameters
vaultId
required
string <uuid> 
Storage vault UID.


 
query Parameters
expand
Array of strings (VdcStorageVaultExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Enum: "VdcVaultTenant" "VdcVaultDataCenter" "VdcVaultCountry" "VdcVaultSubscription"  
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/vdcVault/storageVaults/{vaultId}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Delete Storage Vault
Deletes a storage vault with the specified UID.


Request 
path Parameters
vaultId
required
string <uuid> 
Storage vault UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


delete/vdcVault/storageVaults/{vaultId}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Modify Storage Vault
Modifies a storage vault with the specified UID.


Request 
path Parameters
vaultId
required
string <uuid> 
Storage vault UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


patch/vdcVault/storageVaults/{vaultId}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Veeam Backup & Replication Servers Registered in Veeam Data Cloud Vault
Returns a collection resource representation of all Veeam Backup & Replication servers registered in Veeam Data Cloud Vault.


Request 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/vdcVault/registeredBackupServers
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Register Veeam Backup & Replication Server in Veeam Data Cloud Vault
Registers a specified Veeam Backup & Replication server in Veeam Data Cloud Vault.


Request 
query Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/vdcVault/registeredBackupServers
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get Veeam Backup & Replication Server Registered in Veeam Data Cloud Vault
Returns a resource representation of a Veeam Backup & Replication server that is registered Veeam Data Cloud Vault and is assigned the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/vdcVault/registeredBackupServers/{backupServerUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Unregister Veeam Backup & Replication Server from Veeam Data Cloud Vault
Cancels the registration of a Veeam Backup & Replication server with the specified UID in Veeam Data Cloud Vault.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


delete/vdcVault/registeredBackupServers/{backupServerUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Storage Vaults Assigned to Veeam Backup & Replication Server
Returns a collection resource representation of all storage vaults assigned to a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/vdcVault/registeredBackupServers/{backupServerUid}/assignedVaults
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Assign Storage Vault to Veeam Backup & Replication Server
Assigns a storage vault to a Veeam Backup & Replication server with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
query Parameters
vaultId
required
string <uuid> 
Storage vault UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/vdcVault/registeredBackupServers/{backupServerUid}/assignedVaults
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Storage Vault Assigned to Veeam Backup & Replication Server
Returns a resource representation of a storage vault with the specified UID that is assigned to a Veeam Backup & Replication server.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
vaultId
required
string <uuid> 
Storage vault UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/vdcVault/registeredBackupServers/{backupServerUid}/assignedVaults/{vaultId}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Unassign Storage Vault from Veeam Backup & Replication Server
Unassigns a storage vault with the specified UID from a Veeam Backup & Replication server.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
vaultId
required
string <uuid> 
Storage vault UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


delete/vdcVault/registeredBackupServers/{backupServerUid}/assignedVaults/{vaultId}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Storage Vault Folders
Returns a resource representation of a list of folders that are used to store data on a storage vault with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
vaultId
required
string <uuid> 
Storage vault UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/vdcVault/registeredBackupServers/{backupServerUid}/assignedVaults/{vaultId}/folders
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Create Storage Vault Folder
Creates a folder to store data on a storage vault with the specified UID.


Request 
path Parameters
backupServerUid
required
string <uuid> 
Veeam Backup & Replication server UID.


 
vaultId
required
string <uuid> 
Storage vault UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.7
Request Body schema: application/json
required
name
required
string
Name of a storage folder.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


post/vdcVault/registeredBackupServers/{backupServerUid}/assignedVaults/{vaultId}/folders
Request samples 
application/json
{
  • "name": "Backup"
}
Response samples 
application/json
{
  • "data": {
    }
}