Veeam Service Provider Console 9.2
REST API Reference
Related documents

Preview Operations

Operations that are not fully supported yet and are available for evaluation purposes.

Get All Policies for Mac Computers

Returns a collection resource representation of all backup policies configured for Mac computers.

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.

limit
integer <int32> [ 1 .. 500 ]
Default: 100

Specifies the first N resources that must be returned in the output.

offset
integer <int32> [ 0 .. 2147483647 ]
Default: 0

Excludes the first N resources from the query output.

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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.

get/configuration/backupPolicies/mac
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Backup Policy for Mac Computers
Creates a backup policy for Mac computers.


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.6.2
Request Body schema: application/json
required
Backup policy properties.


name
required
string  [ 1 .. 128 ] characters ^[^~"#%&*:<>?!/\\{|}'`$]+$
Name of a backup policy.


 
accessMode
required
string (BackupPolicyAccessMode) 
Backup policy access mode.


 Enum: "Private" "Public"  
operationMode
required
string (BackupJobOperationMode) 
Backup job operation mode.


 Enum: "Unknown" "Workstation" "Server"  
required
object
Job configuration.


 
description
string  <= 1024 characters 
 Default:  ""
Description of a backup policy.


 
createSubtenants
boolean
 Default:  true
Defines whether a subtenant must be created for each Veeam Agent for Mac.




Available if a cloud repository is selected as backup destination.




 
unlimitedSubtenantQuota
boolean
 Default:  false
Defines whether a subtenant can consume unlimited amount of space on a repository.




Available if a cloud repository is selected as backup destination.




 
repositoryQuotaGb
integer or null <int32> 
 Default:  100
Maximum amount of space that a subtenant can consume on a repository.




If a subtenant can consume unlimited amount of space, the value of this property is ignored.
Available if a cloud repository is selected as backup destination.




 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/configuration/backupPolicies/mac
Request samples 
application/json
{
  • "name": "Mac workstation - Users directory",
  • "description": "This policy processes /Users directory.",
  • "operationMode": "Server",
  • "accessMode": "Public",
  • "createSubtenants": true,
  • "unlimitedSubtenantQuota": false,
  • "repositoryQuotaGB": 100,
  • "jobConfiguration": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Backup Policy for Mac Computers
Returns a resource representation of a Mac computer backup policy with the specified UID.


Request 
path Parameters
policyUid
required
string <uuid> 
Policy 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/configuration/backupPolicies/mac/{policyUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Backup Policy for Mac Computers
Modifies a Mac computer backup policy with the specified UID.


Request 
path Parameters
policyUid
required
string <uuid> 
Policy 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.6.2
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
Modified backup policy.


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) are returned with the 520 HTTP status code. For details, see the response body.


patch/configuration/backupPolicies/mac/{policyUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Download Veeam Backup & Replication Installation File
Downloads the Veeam Backup & Replication disk image file for further installation on a discovered computer with the specified UID.


Request 
path Parameters
computerUid
required
string <uuid> 
Discovered computer 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.6.2
Request Body schema: application/json
required
Installation file download configuration.


path
required
string  [ 1 .. 1024 ] characters 
Path to a folder on a target machine where the Veeam Backup & Replication setup file must be downloaded.


 
Responses 
200
Deployment task UID.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/computers/{computerUid}/installBackupServer/iso/predownload
Request samples 
application/json
{
  • "path": "C:\\ProgramData\\Veeam\\Veeam Availability Console"
}
Response samples 
application/json
{
  • "data": {
    }
}
Download Veeam ONE Installation File
Downloads the Veeam ONE disk image file for further installation on a discovered computer with the specified UID.


Request 
path Parameters
computerUid
required
string <uuid> 
Discovered computer 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.6.2
Request Body schema: application/json
required
Installation file download configuration.


path
required
string  [ 1 .. 1024 ] characters 
Path to a target folder.


 
Responses 
200
Deployment task UID.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/computers/{computerUid}/installVOneServer/iso/predownload
Request samples 
application/json
{
  • "path": "\\\\tech.local\\tech\\VSPC\\VBR\\13\\Butler\\VeeamONE_13.0.0.5457_20250723.iso"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Active Directory Infrastructure
Returns a collection resource representation of organizational units of an Active Directory infrastructure where a management agent with the specified UID is installed.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent 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.6.2
Request Body schema: application/json
discoveryRuleUid
string or null <uuid> 
UID assigned to a discovery rule.


 
object or null
Credentials of an account with Local Administrator permissions on discovered computers.




The null value indicates that management agent credentials will be used as service account credentials.




 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/managementAgents/{managementAgentUid}/adTree/discover
Request samples 
application/json
{
  • "discoveryRuleUid": "ae61e533-82c7-4cb6-a030-78ae589cf49d",
  • "serviceAccount": {
    }
}
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Veeam Products with Available Request Proxying.
Returns a collection resource representation of Veeam products with available request proxying installed on the server where a management agent with the specified UID resides.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/managementAgents/{managementAgentUid}/proxyableProducts
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Active Proxy Sessions.
Returns a collection resource representation of active proxy sessions.


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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/proxy/sessions
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Management Agent Credentials
Get a resource representation of credentials for Veeam Backup & Replication and Veeam backup agent installation configured on a management agent with the specified UID.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/managementAgents/{managementAgentUid}/credentials
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Configure Management Agent Credentials
Configure credentials for Veeam Backup & Replication and Veeam backup agent installation on a management agent with the specified UID.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent 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.6.2
Request Body schema: application/json
required
Parameters of credentials.


username
required
string  [ 1 .. 128 ] characters ^[^\\/:*?"<>|]+\\[^\\/\[\]:;|=,+*?<>@"]+$
Username in the DOMAIN\username format.


 
password
required
string <password>   [ 1 .. 256 ] characters 
Password.


 
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) are returned with the 520 HTTP status code. For details, see the response body.


put/infrastructure/managementAgents/{managementAgentUid}/credentials
Request samples 
application/json
{
  • "username": "hv1\\dma",
  • "password": "Password1"
}
Response samples 
application/json
{
  • "data": {
    }
}
Delete Management Agent Credentials
Deletes credentials for Veeam Backup & Replication and Veeam backup agent installation configured on a management agent with the specified UID.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/managementAgents/{managementAgentUid}/credentials
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Download Veeam Backup & Replication Upgrade Setup File
Downloads the Veeam Backup & Replication upgrade setup file for further installation on 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.6.2
Request Body schema: application/json
required
File download configuration.


path
required
string  [ 1 .. 1024 ] characters 
Path to a folder on a target machine where the Veeam Backup & Replication setup file must be downloaded.


 
Responses 
200
Deployment task UID.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/upgrade/iso/predownload
Request samples 
application/json
{
  • "path": "C:\\ProgramData\\Veeam\\Veeam Availability Console"
}
Response samples 
application/json
{
  • "data": {
    }
}
Starts Patch Upload to Veeam Backup & Replication Server
Initiates an upload of a patch 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.6.2
Request Body schema: application/json
required
required
Array of objects (BackupServerMultipartPatchFileInput) 
Array of files included in a Veeam Backup & Replication server patch upload.


 
action
required
string (BackupServerMultipartPatchAction) 
Action that must be performed on a Veeam Backup & Replication server patch.


 Enum: "ExecuteFile" "ReplaceFilesAndRestart"  
stopAllActivities
required
boolean
Indicates whether all Veeam Backup & Replication activities must be stopped before patch installation begins.


 
rebootAutomatically
required
boolean
Indicates whether a Veeam Backup & Replication server must be rebooted after the patch installation is finished.


 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/patch/upload/multipart/create
Request samples 
application/json
{
  • "files": [
    ],
  • "action": "ReplaceFilesAndRestart",
  • "stopAllActivities": true,
  • "rebootAutomatically": true
}
Response samples 
application/json
{
  • "data": {
    }
}
Upload Patch File Chunk to Veeam Backup & Replication Server
Uploads a patch file chunk to Veeam Backup & Replication server with the specified UID.


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


 
query Parameters
uploadUid
required
string <uuid> 
Upload UID.


 
fileStreamUid
required
string <uuid> 
Single file UID.


 
partNumber
required
integer <int32>   >= 1 
File chunk ordinal number.


 
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.6.2
Request Body schema: application/octet-stream
required
File chunk.




Maximum size is 5 MB. Sending a bigger file chunk can return an unexpected error response.




string <binary>   [ 1 .. 5242880 ] characters 
 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/patch/upload/multipart/uploadPart
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Complete Patch Upload to Veeam Backup & Replication Server
Finalizes an upload of a patch to Veeam Backup & Replication server with the specified UID.


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


 
query Parameters
uploadUid
required
string <uuid> 
Upload 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.6.2
Responses 
200
Deployment task UID.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/patch/upload/multipart/complete
Request samples 
Response samples 
application/json
{
  • "data": "45818675-b248-41e4-911c-83bb3ea9fc3c"
}
Abort Patch Upload to Veeam Backup & Replication Server
Aborts an upload of a patch to Veeam Backup & Replication server with the specified UID.


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


 
query Parameters
uploadUid
required
string <uuid> 
Upload 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/patch/upload/multipart/abort
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Starts Patch Upload to Veeam Backup & Replication Linux Server
Initiates an upload of a patch to a Veeam Backup & Replication linux server with the specified UID.


Request 
path Parameters
clusteredAgentUid
required
string <uuid> 
Clustered management agent 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.6.2
Request Body schema: application/json
required
required
object (BackupServerMultipartPatchFileInput) 
 
stopAllActivities
required
boolean
Indicates whether all Veeam Backup & Replication activities must be stopped before patch installation begins.


 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{clusteredAgentUid}/patchLinux/upload/multipart/create
Request samples 
application/json
{
  • "file": {
    },
  • "stopAllActivities": true
}
Response samples 
application/json
{
  • "data": {
    }
}
Upload Patch File Chunk to Veeam Backup & Replication Linux Server
Uploads a patch file chunk to Veeam Backup & Replication linux server with the specified UID.


Request 
path Parameters
clusteredAgentUid
required
string <uuid> 
Clustered management agent UID.


 
query Parameters
uploadUid
required
string <uuid> 
Upload UID.


 
fileStreamUid
required
string <uuid> 
Single file UID.


 
partNumber
required
integer <int32>   >= 1 
File chunk ordinal number.


 
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.6.2
Request Body schema: application/octet-stream
required
File chunk.




Maximum size is 5 MB. Sending a bigger file chunk can return an unexpected error response.




string <binary>   [ 1 .. 5242880 ] characters 
 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{clusteredAgentUid}/patchLinux/upload/multipart/uploadPart
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Complete Patch Upload to Veeam Backup & Replication Linux Server
Finalizes an upload of a patch to Veeam Backup & Replication linux server with the specified UID.


Request 
path Parameters
clusteredAgentUid
required
string <uuid> 
Clustered management agent UID.


 
query Parameters
uploadUid
required
string <uuid> 
Upload 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.6.2
Responses 
200
Deployment task UID.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{clusteredAgentUid}/patchLinux/upload/multipart/complete
Request samples 
Response samples 
application/json
{
  • "data": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Abort Patch Upload to Veeam Backup & Replication Linux Server
Aborts an upload of a patch to Veeam Backup & Replication linux server with the specified UID.


Request 
path Parameters
clusteredAgentUid
required
string <uuid> 
Clustered management agent UID.


 
query Parameters
uploadUid
required
string <uuid> 
Upload 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{clusteredAgentUid}/patchLinux/upload/multipart/abort
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Starts Patch Upload to Veeam Backup for Public Clouds Appliances registered on Veeam Cloud Connect Site
Initiates an upload of a patch to Veeam Backup for Public Clouds appliances registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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.6.2
Request Body schema: application/json
required
fileName
required
string
Name of a patch file.


 
platform
required
string (BackupServerPublicCloudAppliancePlatformInput) 
Platform of a Veeam Backup for Public Clouds appliance.


 Enum: "Azure" "Amazon" "Google"  
fileSize
required
integer <int64>   [ 1 .. 5368709120 ] 
Size of a patch file, in bytes.


 
Responses 
200
Upload UID.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/{siteUid}/publicCloud/appliances/patches/upload/multipart/create
Request samples 
application/json
{
  • "fileName": "veeamazurebackup_6.0.1.269_amd64.deb",
  • "platform": "Azure",
  • "fileSize": 164106630
}
Response samples 
application/json
{
  • "data": "97530cc6-56ec-4939-9252-5f36733b5ec5"
}
Upload Patch File Chunk to Veeam Backup for Public Clouds Appliances Registered on Veeam Cloud Connect Site
Uploads a patch file chunk to Veeam Backup for Public Clouds appliances registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
uploadUid
required
string <uuid> 
Upload UID.


 
partNumber
required
integer <int32>   >= 1 
File chunk ordinal number.


 
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.6.2
Request Body schema: application/octet-stream
required
File chunk.




Maximum size is 5 MB. Sending a bigger file chunk can return an unexpected error response.




string <binary>   [ 1 .. 5242880 ] characters 
 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/{siteUid}/publicCloud/appliances/patches/upload/multipart/uploadPart
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Complete Patch Upload to Veeam Backup for Public Clouds Appliances registered on Veeam Cloud Connect Site
Finalizes an upload of a patch to Veeam Backup for Public Clouds appliances registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
uploadUid
required
string <uuid> 
Upload 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/{siteUid}/publicCloud/appliances/patches/upload/multipart/complete
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Abort Patch Upload to Veeam Backup for Public Clouds Appliances registered on Veeam Cloud Connect Site
Aborts an upload of a patch to Veeam Backup for Public Clouds appliances registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
uploadUid
required
string <uuid> 
Upload 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/{siteUid}/publicCloud/appliances/patches/upload/multipart/abort
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Google Cloud Accounts
Returns a collection resource representation of all Google Cloud accounts managed by a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
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.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/google/accounts
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Google Cloud Account
Creates a Google Cloud account in a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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.6.2
Request Body schema: application/json
required
Google Cloud account parameters.


name
required
string  [ 1 .. 255 ] characters 
Name of a Google Cloud account.


 
jsonConfiguration
required
string
Configuration file of a Google Cloud account in the JSON format.


 
description
string or null  <= 250 characters 
Description of a Google Cloud account.


 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/{siteUid}/publicCloud/google/accounts
Request samples 
application/json
{
  • "name": "Provider",
  • "description": "Provider Account",
  • "jsonConfiguration": "{\"type\":\"service_account\",\"project_id\":\"vspc\",\"private_key_id\":\"4a79cbf96aa94266407fa1a8fd39d6983989fd8\",\"private_key\":\"-----BEGINPRIVATEKEY-----\\nMIIEowIBAAKCAQEAsUyvEXIzY2iHzUwtNCUTUDEGeEaWt667b8tbbehcmJmieP42T5bh0lIWvET9h03LGutYD4f0lH74EihHaBHt45B4ei9EiJGATPgLfdc4MOsiQcbf6HjrkuVzru4SDnesUEkDYczXNh/int7Uvuhafv0hKu3ZOfQPtPmJKBc+fQCBt6ZgSxQ1BqOR+p8MCkxxVr4zUphsQCU+kCWzilyPlFHSKtb/JggDGMnLiZiY1MnU1FkC4rTY2COlcNzq8PtEF6BuAO1L1788eh+h2oesG78kttuNmtTrXFlaCFzwOGmoKg2aAPIJVYNt5V3Vevm9kzcx5BAjeiKUZipGH8XQIDAQABAoIBABlUflJ8wVC7d2NiNbcUcOztBCKc2x2E7ixrnjVWlBwNHwQwNWwrfznAFpVxOdNhztmas+sMHmo0tZZKgOEiZp0zX7L9G8pzFyRn76Rb4iBDB5LkKcsZs3Y6J8vfIV9Fw614sO4BCOInrgXKihR4N62a1mk+r+EyuCe/2tOKdpf/BKjGLX9hhEglMFpscsCK6vMya+Eo1mpjTlqsTCQQEs031kRCcRFq4VBaLx/xgCAVLA0vTBUeGV7hx/VpGU3yy+flI+O3ny6lwaThe6ulkh3Y7S/dAyp6JYt/kmi6ZD0My8xTiOd4fw+zqDrt5UtROGAVMKHpCT7g9ElyGTLsTUCgYEA1sxtK2U/PVWsjq/ZK388zuSJ2QXMch+65xM+JZkPtbohzjlIFmGGyTN+kkMC3H1/xe+/y0GrB9OdzqLqiQQhOkXkzHuMAbqGoGKcywO1KqrKeD1C3Z4/ha4yLALF5M/ihCvCZ2k5mmfwCKX+5+kPhaqUOeJoO0C4DxLwdiI508CgYEA007jZqvy/3ct2LtREZgqsHggoyZOtYwtL8bvNuIMX/Z/fDlsdhjqFJCmYzgmVzpGpruac9dSBdPbOIs6cnkdnvdttwPgX9lrlW7DXFNCiXWdCTN7UlVDIKRCDjIlVKgsoI7EKewT6oGzjfhgejTRp4a8XvQfxqUWVOx4cIy9tpMCgYEAl2h5+4De1ukxPVMPDe4eeuf1kxjXSAq9wGx8dqPL/c+XENo2CFuSgEetOaOL7fVipXGjnFOsxF88/CY0lLXfPxDfIU6sywXUtuJhKVYBDj9Pb7G2iWH1X4W8sxoEd5W/0B56g5ivyArkJJc98oxRRcLMQ0MybFElGdLmw7lSp1kCgYB08nE6jqnTJ3ORQsJwWWYu+p0djoL7SVRs383e8yZkKfmOl/1mMw3CSfg8a4QUvKUDfErUF/RGU2U9mxjC6DMzmr73Dkcs5Rj8wCuROmdVymkaAYscGyImu6HvV2N/wf/I8JqylPzEyfnE9hT3Lapm7FPuvW+kshN09tcFe283zwKBgBg/NFAjO0CniYina6FM9KH4uk//5JZ9nXV9nkBRiykIzeWURcf1WfbpPIeQgIcx6/CKb/Peay41OIvN2gegyhLFaPbylN1xkBq9Yc5xkxKapReH+yIoiwO86Cc4QJVjLp3pQBy0+lXRwyRMg5sEcBQeQGBu5JpJh0hQTQ0Drj+i\\n-----ENDPRIVATEKEY-----\\n\",\"client_email\":\"provider@mycompany.iam.gserviceaccount.com\",\"client_id\":\"218140769437899532786\",\"auth_uri\":\"https://accounts.google.com/o/oauth2/auth\",\"token_uri\":\"https://oauth2.googleapis.com/token\",\"auth_provider_x509_cert_url\":\"https://www.googleapis.com/oauth2/v1/certs\",\"client_x509_cert_url\":\"https://www.googleapis.com/robot/v1/metadata/x509/provider%40mycompany.iam.gserviceaccount.com\",\"universe_domain\":\"googleapis.com\"}"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Google Cloud Account
Returns a resource representation of a Google Cloud account with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
accountUid
required
string <uuid> 
Google Cloud account 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/google/accounts/{accountUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Google Cloud Account
Modifies a Google Cloud account with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
accountUid
required
string <uuid> 
Google Cloud account 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/sites/{siteUid}/publicCloud/google/accounts/{accountUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Google Cloud Account
Delete a Google Cloud account with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
accountUid
required
string <uuid> 
Google Cloud account 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/sites/{siteUid}/publicCloud/google/accounts/{accountUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Google Cloud Datacenters
Returns a collection resource representation of all Google Cloud datacenters managed by Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
accountUid
required
string <uuid> 
Google Cloud account UID.


 
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.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/google/datacenters
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Google Cloud Zones
Returns a collection resource representation of all Google Cloud zones.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
accountUid
required
string <uuid> 
Google Cloud account UID.


 
dataCenterId
required
string
Google Cloud datacenter ID.


 
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.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/google/availabilityZones
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Google Cloud Networks
Returns a collection resource representation of all Google Cloud networks managed by a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
accountUid
required
string <uuid> 
Google Cloud account UID.


 
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.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/google/networks
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Google Cloud Subnets
Returns a collection resource representation of all Google Cloud subnets registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
accountUid
required
string <uuid> 
Google Cloud account UID.


 
dataCenterId
required
string
Google Cloud datacenter ID.


 
networkId
required
string
Google Cloud network ID.


 
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.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/google/subnets
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Google Cloud Network Tags
Returns a collection resource representation of all Google Cloud network tags registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
accountUid
required
string <uuid> 
Google Cloud account UID.


 
networkId
required
string
Google Cloud network ID.


 
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.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/google/networkTags
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Veeam Cloud Connect Site IP Adresses in Google Cloud
Returns a collection resource representation of IP addresses specified in Google Cloud for a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/google/backupServerIpAddresses
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get Google Cloud Account IP Addresses
Returns a collection resource representation of all existing IP addresses available to Google Cloud accounts registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
accountUid
required
string <uuid> 
Google Cloud account UID.


 
dataCenterId
required
string
Google Cloud datacenter ID.


 
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.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/google/ipAddresses
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Google Cloud VMs
Returns a collection resource representation of all Google Cloud VMs registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
query Parameters
accountUid
required
string <uuid> 
Google Cloud account UID.


 
dataCenterId
required
string
Google Cloud datacenter ID.


 
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.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/google/virtualMachines
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Veeam Backup for Google Cloud Appliance
Creates a new Veeam Backup for Google Cloud appliance registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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.6.2
Request Body schema: application/json
required
required
object
 
required
object
 
required
object
 
required
object
 
object or null
Veeam Backup for Google Cloud appliance network resources.




If you provide the null value, all required resources will be created automatically.




 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/{siteUid}/publicCloud/google/appliances/deploy
Request samples 
application/json
{
  • "account": {
    },
  • "virtualMachine": {
    },
  • "network": null,
  • "ipAddress": {
    },
  • "guestOsCredentials": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Connect Veeam  Backup for Google Cloud Appliance
Connects an existing Veeam Backup for Google Cloud appliance registered on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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.6.2
Request Body schema: application/json
required
required
object
 
required
object
 
required
object
 
object or null
Veeam Backup for Google Cloud appliance connection settings.




Send null to connect a Veeam Backup for Google Cloud appliance directly to the internet.




 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/{siteUid}/publicCloud/google/appliances/connect
Request samples 
application/json
{
  • "account": {
    },
  • "virtualMachine": {
    },
  • "network": null,
  • "guestOsCredentials": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Veeam Backup for Google Cloud Appliance
Returns a resource representation of a Veeam Backup for Google Cloud appliance with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
applianceUid
required
string <uuid> 
Veeam Backup for Google Cloud appliance 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/{siteUid}/publicCloud/google/appliances/{applianceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Veeam Backup for Google Cloud Appliance
Modifies a Veeam Backup for Google Cloud appliance with the specified UID.


Request 
path Parameters
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
applianceUid
required
string <uuid> 
Veeam Backup for Google Cloud appliance 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/sites/{siteUid}/publicCloud/google/appliances/{applianceUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Veeam Backup for Public Clouds Appliances to Create SQL Accounts
Returns a collection of resource representation of all Veeam Backup for Public Clouds appliances on which SQL accounts can be created.


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.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/publicCloud/sqlAccounts/appliances
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Available Public Cloud SQL accounts.
Returns a collection resource representation of all available public cloud SQL accounts.


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.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/publicCloud/sqlAccounts
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Public Cloud SQL Account.
Creates a new public cloud SQL account.


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.6.2
Request Body schema: application/json
required
Public cloud SQL account parameters.


accountName
required
string  [ 1 .. 255 ] characters ^[^^!`$&+,:;#|/<>%'"]+$
Name of a public cloud SQL account.


 
databaseType
required
string (PublicCloudSqlAccountDatabaseType) 
Type of a public cloud SQL database.


 Enum: "AzureSql" "GcpMySqlBuiltIn" "GcpPostgres" "AwsSql"  
userName
required
string or null  <= 255 characters 
User name.


 
password
required
string or null <password>   <= 255 characters 
Password.


 
applianceUid
required
string <uuid> 
UID assigned to a Veeam Backup for Public Clouds appliance.


 
description
string or null  <= 512 characters 
Description of a public cloud SQL account.


 
Responses 
200
Resource representation of a created account.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/publicCloud/sqlAccounts
Request samples 
application/json
{
  • "accountName": "Admin",
  • "databaseType": "AzureSql",
  • "userName": "admin",
  • "password": "Password1",
  • "description": "Admin credentials",
  • "applianceUid": "6d18e5fe-20e5-4248-a87f-29a109a44b80"
}
Response samples 
application/json
{
  • "data": {
    }
}
Recollect Public Cloud SQL Account Data
Retrieves and updates data of public cloud SQL accounts.


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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/sites/publicCloud/sqlAccounts/sync
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Public Cloud SQL account
Returns a resource representation of a public cloud SQL account with the specified ID.


Request 
path Parameters
sqlAccountId
required
string
Public cloud SQL account ID.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/sites/publicCloud/sqlAccounts/{sqlAccountId}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Public Cloud SQL Account
Modifies a public cloud SQL account with the specified ID.


Request 
path Parameters
sqlAccountId
required
string
Public cloud SQL account ID.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/sites/publicCloud/sqlAccounts/{sqlAccountId}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Public Cloud SQL Account
Deletes a public cloud SQL account with the specified ID.


Request 
path Parameters
sqlAccountId
required
string
Public cloud SQL account ID.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/sites/publicCloud/sqlAccounts/{sqlAccountId}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Create Windows Local Backup Repository Connected to Backup Server
Creates a Windows local backup repository connected to a Veeam Backup & Replication server with the specified UID.


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


 
query Parameters
overwriteOwner
boolean or null
 
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.6.2
Request Body schema: application/json
required
name
required
string
Name of a repository.


 
description
required
string
Description of a repository.


 
hostId
required
string <uuid> 
Host ID associated with the repository.


 
required
object
Repository settings.


 
uniqueId
string or null
Unique ID assigned to a repository.


 
importBackup
boolean or null
Indicates whether Veeam Backup & Replication will search a repository for existing backups and import them automatically.


 
importIndex
boolean or null
Indicates whether Veeam Backup & Replication will import the guest OS file system index.


 
object or null
Mount server settings. If the value is not provided, the default Veeam Backup & Replication mount server will be used.


 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/repositories/winLocal
Request samples 
application/json
{
  • "description": "Created by MyCompany admin",
  • "name": "LocalRepo2",
  • "hostId": "6d18e5fe-20e5-4248-a87f-29a109a44b80",
  • "repository": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Create Veeam Data Cloud Vault Backup Repository Connected to Backup Server
Creates a Veeam Data Cloud Vault backup repository connected to a Veeam Backup & Replication server with the specified UID.


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


 
query Parameters
overwriteOwner
boolean or null
 
importBackup
boolean or null
 Default:  false
Defines whether Veeam Backup & Replication will search the repository for existing backups and import them automatically.


 
importIndex
boolean or null
 Default:  false
Defines whether Veeam Backup & Replication will import the guest OS file system index.


 
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.6.2
Request Body schema: application/json
required
name
required
string
Name of a repository.


 
required
object (BackupServerVeeamDataCloudStorageAccount) 
Veeam account settings.


 
required
object (BackupServerVeeamDataCloudStorageContainer) 
Storage container settings.


 
description
string or null
Description of a repository.


 
uniqueId
string or null
Unique identifier assigned to a repository.


 
taskLimitEnabled
boolean or null
Indicates whether the number of concurrent task is limited.


 
maxTaskCount
integer or null <int32> 
Maximum number of concurrent tasks.


 
object or null
Mount server settings. If no property value is provided, the default Veeam Backup & Replication mount server will be used.


 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/repositories/veeamVault
Request samples 
application/json
{
  • "description": "Created by Veeam Service Provider Console VSPC1\\Administrator at 3/17/2026 2:03:57 PM.",
  • "name": "ALpha Vault Repository",
  • "uniqueId": "F4B1ABA32F964CC5A5DF156E3DF5146E",
  • "taskLimitEnabled": false,
  • "maxTaskCount": 2,
  • "mountServer": {
    },
  • "account": {
    },
  • "container": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Delete Backup Repository
Deletes a backup repository with the specified UID.


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


 
repositoryUid
required
string <uuid> 
Backup repository.


 
query Parameters
deleteBackups
boolean
 Default:  false
Defines whether the backups stored on the repository must be deleted.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/backupServers/{backupServerUid}/repositories/{repositoryUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Veeam Data Cloud Vault Backup Repository
Returns a resource representation of a Veeam Data Cloud Vault backup repository with the specified UID.


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


 
repositoryUid
required
string <uuid> 
Backup repository.


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


Items Value: "BackupRepository"  
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/repositories/{repositoryUid}/veeamVault
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Veeam Data Cloud Vault Backup Repository
Modifies a Veeam Data Cloud Vault backup repository with the specified UID.


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


 
repositoryUid
required
string <uuid> 
Backup repository.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/backupServers/{backupServerUid}/repositories/{repositoryUid}/veeamVault
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get Windows Local Backup Repository
Returns a resource representation of a Windows local backup repository with the specified UID.


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


 
repositoryUid
required
string <uuid> 
Backup repository.


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


Items Value: "BackupRepository"  
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/repositories/{repositoryUid}/winLocal
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Windows Local Backup Repository
Modifies a Windows local backup repository with the specified UID.


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


 
repositoryUid
required
string <uuid> 
Backup repository.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/backupServers/{backupServerUid}/repositories/{repositoryUid}/winLocal
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get Veeam Backup & Replication Server Credentials.
Returns a collection resource representation of all credentials stored on Veeam Backup & Replication server with the specified UID.


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


 
query Parameters
mappedOrganizationUidFilter
string or null <uuid> 
Value of a mappedOrganizationUid property that a resource must have to be included in a response.


 
orderColumn
string or null
Property by whose values the resources in a response must be sorted.


 Enum: "Username" "Description"  
orderAsc
boolean or null
Determines whether resources in a response are retuned in the ascending order based on the orderColumn property value.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/credentials
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Delete Veeam Backup & Replication Server Credentials Record.
Deletes Veeam Backup & Replication server credentials record with the specified UID.


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


 
credentialsUid
required
string <uuid> 
Credentials record 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/backupServers/{backupServerUid}/credentials/{credentialsUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Add Veeam Backup & Replication Server Standard Credentials.
Adds standard credentials for 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.6.2
Request Body schema: application/json
required
Veeam Backup & Replication server credentials.


username
required
string  non-empty 
User name.


 
password
required
string <password>   non-empty 
Password.


 
description
string or null  <= 256 characters 
Credentials description.


 
mappedOrganizationUid
string or null <uuid> 
UID of a company to whom credentials are assigned.


 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/credentials/standard
Request samples 
application/json
{
  • "username": "admin",
  • "password": "Password1",
  • "description": "Credentials for Alpha company administrator",
  • "mappedOrganizationUid": "988c4583-5336-4e20-892d-eabcca0b34ac"
}
Response samples 
application/json
{
  • "data": {
    }
}
Add Veeam Backup & Replication Server Linux Credentials
Adds Linux credentials for 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.6.2
Request Body schema: application/json
required
Linux credentials.


username
required
string  non-empty ^\S+$
User name.


 
password
string or null <password> 
Password.


 
description
string or null  <= 256 characters 
Description of credentials.


 
mappedOrganizationUid
string or null <uuid> 
UID of a company to whom credentials must be assigned.


 
sshPort
integer <int32> 
 Default:  22
SSH port used to connect to a Linux server.


 
autoElevated
boolean
 Default:  false
Indicates whether the account that owns credentials has permissions of a root user.


 
addToSudoers
boolean
 Default:  false
Indicates whether the account that owns credentials is added to the sudoers file.


 
useSu
boolean
 Default:  false
Indicates whether the su command is used for Linux distributions where the sudo command is not available.


 
privateKey
string or null <password> 
Private key.


 
passphrase
string or null <password> 
Passphrase for the private key.


 
rootPassword
string or null <password>   <= 4096 characters 
Password of a root account.


 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/credentials/linux
Request samples 
application/json
{
  • "username": "admin",
  • "password": "Password1",
  • "description": "Credentials for Alpha company administrator",
  • "mappedOrganizationUid": "988c4583-5336-4e20-892d-eabcca0b34ac",
  • "sshPort": 22,
  • "autoElevated": true,
  • "addToSudoers": true,
  • "useSu": false,
  • "privateKey": "-----BEGIN RSA PRIVATE KEY-----MIIEowIBAAKCAQEAmqsrgygo+hDxXAZVB6nyqAL/O8h+SQn/iVcW8wfCsqw7S9KMnRvEQ3PM7ULZvOFDKCoBt1j4kHELVm3HKRtqatEyqCPrB8gBZuTVsi14naNYL40qJqgCuMCsNRosoG6pSUEwddSQ2uELez3eDm/f0H0kuyMf3VRqz5o3mRo0Vujs+xhD8FXQYEuTvEANetdIlA8FrQQAlx0dxTKuKK1tYvbPqASP01eHmj/Vr/nKJX/BoZcSSSbEwpbqS4KlQHhlC0a7x/pfTurLwNKCQJWivhab6hCUanpttac3Hb2hQFdhymoI15j571i9yXam6Ul6i9qkW+M0x7m8Kd6lrOyVnwIDAQABAoIBAFib+9+2IFOzZTNdhVVQre5HWUY8xOy/R6C9Pi6ZoZePSKFVzK0tfTFPpHXBONEXFMxr1HPgCvdlbCNl3RXV2Q+9LhJaEYpxsSvrqencVx+otxr2+tEOrBCAgagiiLKY828+Y679ysc66sL+XLtUqJrfNy3nH5hDhrXNGlEiTB4Fi85f4us4Iqzg3Wc2TdAL6GX8qGmzopHG2PWGjHVeVnPerBfLgXhEtZSng3B57LGs9KQzfOi9kie0Cso3e5yorky10Y4B7cd/hioI34PZMlfSsRuc0UfnQUAtLMiLCSFBejZbyvp8EW3sVLzN/Ho1aKbQWS7A9m0FKKddJyVptdECgYEAx+2WSjaOL9HQMgT+j9U0DfXY321m+F/IRfcDRIBE/4fVeB2sfS5k/4zvgXEAsmoclRea7S8d2gQ81yo87mQbfkseM1SeA7uQzjOTPTiIcdNip/O5kDKUMszaMqckDAVflcD8M+F+mXdoLUgFH13S/UVRHZLJUoK1wP0RmIWqLQUCgYEAxgwM+m1hXfLPQi//D1aPk1ok3n1++aSCkzzucrMQ+pIZOnpE6x0EOBrccc9qkYzuDAj7VTJKhD39OD8+ZIIkICo1m9RVjfP/t+mgycBp4LaFsPaq7hhJOVhU7UvupnqJpOag3VUTKeUWtxbozNS/KqZa1bTq/kCEr4d42wH4mVMCgYAC3hmFvvqTHQNLdF7iWUCB4sDVk5Aih90rg7t8RAq5T410R5itwviX4cGdra1A4dy/FrOWK1LWSbFFtMli8fSi/xjTy6bojswo6Px3qFPsrgeAOTK0KsWNZPrMNzGBKqKQV1BGvjk+okPQQnQwWvwnvdLIBc71bAKHXhnegixKsQKBgQC0pmFgPU3HaKhtc2JxF0A35M4ktMyR4uHIdJf8wCIIriOdF9Kts/YZR0c1+UD4K1koWTkI6arXHcRQ/j9nZt6VCGuGDRVNOvhTRiSIY58wfs1MMnSQYk7IpC4zlkPGT5gmdsjdm7CzUmh58cfAr38A5GWO8kw4R5nAkw5Gl3GwSQKBgCgsVH+KxM4Y1jTyL+p/JK3roQ4wbFPQH3yTOYbQKUcLjzXY9yQ4OecoUoXjrbsaMn6unRdoSgosxP9s4OoTHpUdUfWJhhjr3zvm6/tU3dPc+U0UbUf4DZvto+JzdSVqUtBQlo5T/yYK0OIhQakvHGunaeWnj4cUT86kFzTizeJT-----END RSA PRIVATE KEY-----",
  • "passphrase": "Passphrase1",
  • "rootPassword": "Rootpass1"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Veeam Backup & Replication Server Encryption Passwords
Returns a collection resource representation of all encryption passwords created on a Veeam Backup & Replication server with the specified UID.


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


 
query Parameters
mappedOrganizationUidFilter
string or null <uuid> 
Value of a mappedOrganizationUid property that a resource must have to be included in a response.


 
orderColumn
string or null
Property by whose values the resources in a response must be sorted.


 Enum: "Hint" "ModificationTime"  
orderAsc
boolean or null
Defines whether resources in a response are retuned in the ascending order based on the orderColumn property value.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupServers/{backupServerUid}/encryptionPasswords
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Veeam Backup & Replication Server Encryption Password
Creates a new encryption password on 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.6.2
Request Body schema: application/json
required
Veeam Backup & Replication server encryption password.


password
required
string <password>   <= 1024 characters 
Veeam Backup & Replication encryption password.


 
hint
required
string  [ 1 .. 405 ] characters ^[^|]*$
Hint for a Veeam Backup & Replication server encryption password.


 
uniqueId
string or null  <= 256 characters 
Unique ID assigned to a Veeam Backup & Replication server encryption password.


 
mappedOrganizationUid
string or null <uuid> 
UID of a company to whom a Veeam Backup & Replication server encryption password is assigned.


 
mappedOrganizationName
string or null
Name of a company to whom a Veeam Backup & Replication server encryption password is assigned.


 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupServers/{backupServerUid}/encryptionPasswords
Request samples 
application/json
{
  • "password": "Password1",
  • "uniqueId": "85690e8b-df4a-446e-8f66-d00ad6e6d2d4",
  • "hint": "Standard password",
  • "mappedOrganizationUid": "988c4583-5336-4e20-892d-eabcca0b34ac",
  • "mappedOrganizationName": "Alpha"
}
Response samples 
application/json
{
  • "data": {
    }
}
Delete Veeam Backup & Replication Server Encryption Password
Deletes a Veeam Backup & Replication server encryption password with the specified UID.


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


 
passwordUid
required
string <uuid> 
Veeam Backup & Replication server encryption password 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


delete/infrastructure/backupServers/{backupServerUid}/encryptionPasswords/{passwordUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Configuration of Veeam Agent for Mac Job
Returns a resource representation of a configuration of a Veeam Agent for Mac job with the specified UID.


Request 
path Parameters
backupAgentUid
required
string <uuid> 
Veeam Agent for Mac UID.


 
backupAgentJobUid
required
string <uuid> 
Veeam Agent for Mac job 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/backupAgents/mac/{backupAgentUid}/jobs/{backupAgentJobUid}/configuration
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Configuration of Veeam Agent for Mac Job
Modifies configuration of a Veeam Agent for Mac job with the specified UID.


Request 
path Parameters
backupAgentUid
required
string <uuid> 
Veeam Agent for Mac UID.


 
backupAgentJobUid
required
string <uuid> 
Veeam Agent for Mac job 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


patch/infrastructure/backupAgents/mac/{backupAgentUid}/jobs/{backupAgentJobUid}/configuration
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Create Configuration of Job for Veeam Agent for Mac
Creates a configuration of a Veeam backup agent job protecting Mac computer with the specified UID.


Request 
path Parameters
backupAgentUid
required
string <uuid> 
Veeam Agent for Mac 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.6.2
Request Body schema: application/json
required
Veeam Agent for Mac job configuration


name
required
string  non-empty ^[^~"#%&*:<>?!/\\{|}'`$]+$
Name of a backup policy.


 
operationMode
required
string (BackupJobOperationMode) 
Backup job operation mode.


 Enum: "Unknown" "Workstation" "Server"  
required
object
Job configuration.


 
description
string or null  <= 1024 characters 
Description of a backup policy.


 
object or null (CloudRepositoryConnectionSettings) 
Settings required to connect a cloud repository that is used as a target location for backups.


 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/backupAgents/mac/{backupAgentUid}/jobs/configuration
Request samples 
application/json
{
  • "name": "ServerEntireCloud_Custom",
  • "description": "Mac Policy",
  • "operationMode": "Server",
  • "cloudRepositoryConnectionSettings": {
    },
  • "jobConfiguration": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Backups of All Protected Cloud VMs
Returns a collection resource representation of all backups of protected cloud VMs.




This operation is not optimized for large-scale environments.




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.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/protectedWorkloads/publicCloud/virtualMachines/backups
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Backups of All Protected Cloud Databases
Returns a collection resource representation of all backups of protected cloud databases.




This operation is not optimized for large-scale environments.




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.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/protectedWorkloads/publicCloud/databases/backups
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Protected Cloud File Share Backups
Returns a collection resource representation of all backups created for protected cloud file shares.




This operation is not optimized for large-scale environments.




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.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/protectedWorkloads/publicCloud/fileShares/backups
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Session States Dashboard
Returns a resource representation of the Session States dashboard.


Request 
query Parameters
from
required
string <date-time> 
Start date and time of the period for which job session data is collected.


 
to
required
string <date-time> 
End date and time of the period for which job session data is collected.


 
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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


get/infrastructure/jobSessionHeatmap/
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Download Veeam ONE Upgrade Setup File
Downloads the Veeam ONE upgrade setup file for further installation to a server with the specified UID.


Request 
path Parameters
vOneServerUid
required
string <uuid> 
Veeam ONE 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.6.2
Request Body schema: application/json
required
File download configuration.


path
required
string  [ 1 .. 1024 ] characters 
Path to a target folder.


 
Responses 
200
Deployment task UID.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/voneServers/{vOneServerUid}/upgrade/iso/predownload
Request samples 
application/json
{
  • "path": "C:\\ProgramData\\Veeam\\Veeam Availability Console"
}
Response samples 
application/json
{
  • "data": {
    }
}
Start Veeam ONE Patch Upload to Server
Initiates upload of a Veeam ONE patch to a server with the specified UID.


Request 
path Parameters
vOneServerUid
required
string <uuid> 
Veeam ONE 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.6.2
Request Body schema: application/json
required
required
Array of objects (VOneServerMultipartPatchFileInput) 
Array of files included in a Veeam ONE server patch upload.


 
stopAllActivities
required
boolean
Indicates whether all Veeam ONE activities must be stopped before patch installation begins.


 
rebootAutomatically
required
boolean
Indicates whether a Veeam ONE server must be rebooted after the patch installation is finished.


 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/voneServers/{vOneServerUid}/patch/upload/multipart/create
Request samples 
application/json
{
  • "files": [
    ],
  • "action": "ReplaceFilesAndRestart",
  • "stopAllActivities": true,
  • "rebootAutomatically": true
}
Response samples 
application/json
{
  • "data": {
    }
}
Upload Patch File Chunk to Veeam ONE Server
Uploads a patch file chunk to Veeam ONE server with the specified UID.


Request 
path Parameters
vOneServerUid
required
string <uuid> 
Veeam ONE server UID.


 
query Parameters
uploadUid
required
string <uuid> 
Upload UID.


 
fileStreamUid
required
string <uuid> 
Single file UID.


 
partNumber
required
integer <int32>   >= 1 
File chunk ordinal number.


 
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.6.2
Request Body schema: application/octet-stream
required
File chunk.




Maximum size is 5 MB. Sending a bigger file chunk can return an unexpected error response.




string <binary>   [ 1 .. 5242880 ] characters 
 
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/voneServers/{vOneServerUid}/patch/upload/multipart/uploadPart
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Complete Patch Upload to Veeam ONE Server
Finalizes upload of a Veeam ONE patch to a server with the specified UID.


Request 
path Parameters
vOneServerUid
required
string <uuid> 
Veeam ONE server UID.


 
query Parameters
uploadUid
required
string <uuid> 
Upload 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.6.2
Responses 
200
Deployment task UID.


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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/voneServers/{vOneServerUid}/patch/upload/multipart/complete
Request samples 
Response samples 
application/json
{
  • "data": "5e6bee18-a91e-4b1d-a77e-f9ae815b6730"
}
Abort Patch Upload to Veeam ONE Server
Aborts upload of a Veeam ONE patch to a server with the specified UID.


Request 
path Parameters
vOneServerUid
required
string <uuid> 
Veeam ONE server UID.


 
query Parameters
uploadUid
required
string <uuid> 
Upload 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.6.2
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) are returned with the 520 HTTP status code. For details, see the response body.


post/infrastructure/voneServers/{vOneServerUid}/patch/upload/multipart/abort
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Veeam Data Cloud Vault Cobfiguration 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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.6.2
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) 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": {
    }
}