Veeam Service Provider Console 9.1
REST API Reference
Related documents

Public Cloud Azure

This resource collection represents Microsoft Azure entities connected to Veeam Service Provider Console.

Add Existing Microsoft Azure Account

Registers an existing Microsoft Azure 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.1
Request Body schema: application/json
required
accountName
required
string [ 1 .. 255 ] characters

Name of a Microsoft Azure account.

environment
required
string (EAzureAccountEnvironmentId)

Type of a Microsoft Azure cloud environment.

Enum: "Global" "China" "UsGovernment"
applicationId
required
string

ID assigned to a Microsoft Azure application.

tenantId
required
string

ID assigned to a tenant available to a Microsoft Azure account.

secret
required
string

Client secret.

description
string or null <= 250 characters

Description of a Microsoft Azure 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/azure/accounts/existing
Request samples
application/json
{
  • "accountName": "a_[b142487f-05d6-416a-8a03-c95cbcfed149]",
  • "description": "Created at [1:46:54 PM] by [PortalAdministrator]",
  • "environment": "Global",
  • "applicationId": "09a9bc28-77fd-43c7-ab60-6f8ddc4fffca",
  • "tenantId": "070e5135-0c8b-4598-9a4d-8258e941fcd9",
  • "secret": "uXU9S~HkIG.4ENKZIZE_BwqDd15hfsSkTbwSVa0a"
}
Response samples
application/json
{
  • "data": {
    }
}

Create Microsoft Azure Account

Creates a new Microsoft Azure account 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.1
Request Body schema: application/json
required
accountName
required
string [ 1 .. 255 ] characters

Name of an account.

environment
required
string (EAzureAccountEnvironmentId)

Type of a Microsoft Azure cloud environment.

Enum: "Global" "China" "UsGovernment"
userCode
required
string

User code.

description
string or null <= 250 characters

Description of an 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/azure/accounts
Request samples
application/json
{
  • "accountName": "a_[b142487f-05d6-416a-8a03-c95cbcfed149]",
  • "description": "Created at [1:46:54 PM] by [PortalAdministrator]",
  • "environment": "Global",
  • "userCode": "GPSCNGW9V"
}
Response samples
application/json
{
  • "data": {
    }
}

Get All Microsoft Azure Accounts

Returns a collection resource representation of all Microsoft Azure 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
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.1
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/azure/accounts
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Microsoft Azure Account
Returns a resource representation of a Microsoft Azure account with the specified UID.


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


 
accountUid
required
string <uuid> 
Microsoft Azure 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.1
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/azure/accounts/{accountUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Microsoft Azure Account
Modifies a Microsoft Azure account with the specified UID.


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


 
accountUid
required
string <uuid> 
Microsoft Azure 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.1
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/azure/accounts/{accountUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Microsoft Azure Account
Deletes a Microsoft Azure account with the specified UID.


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


 
accountUid
required
string <uuid> 
Microsoft Azure 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.1
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/azure/accounts/{accountUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Renew Microsoft Azure Account Secret
Renews client secret of a Microsoft Azure account with the specified UID.


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


 
accountUid
required
string <uuid> 
Microsoft Azure 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.1
Request Body schema: application/json
required
userCode
required
string
Verification code used to authenticate to the Azure CLI.


 
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/azure/accounts/{accountUid}/renew
Request samples 
application/json
{
  • "userCode": "GPSCNGW9V"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Device Authentication Code
Returns a resource representation of a Microsoft Azure device authentication code.


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


 
query Parameters
environment
required
string
Type of a Microsoft Azure cloud environment.


 Enum: "Global" "Germany" "China" "UsGovernment"  
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.1
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/azure/accounts/deviceCode
Request samples 
Response samples 
application/json
{}
Get All Microsoft Azure Subscriptions
Returns a collection resource representation of all Microsoft Azure subscriptions 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
connectionUid
required
string <uuid> 
Microsoft Azure connection 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.1
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/azure/subscriptions
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Microsoft Azure Connection
Creates a new Microsoft Azure connection 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> 
Microsoft Azure account UID.


 
environment
required
string
Type of a Microsoft Azure cloud environment.


 Enum: "Global" "Germany" "China" "UsGovernment"  
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.1
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/azure/connection
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Delete Microsoft Azure Connection
Deletes a Microsoft Azure connection with the specified UID.


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


 
connectionUid
required
string <uuid> 
Microsoft Azure connection 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.1
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/azure/connection/{connectionUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Microsoft Azure Networks
Returns a collection resource representation of all Microsoft Azure virtual networks 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
connectionUid
required
string <uuid> 
Microsoft Azure connection UID.


 
subscriptionId
required
string
Microsoft Azure subscription ID.


 
dataCenterId
required
string
Microsoft Azure 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.1
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/azure/networks
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Microsoft Azure IP Addresses
Returns a collection resource representation of all existing IP addresses available to Microsoft Azure 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
connectionUid
required
string <uuid> 
Microsoft Azure connection UID.


 
subscriptionId
required
string
Microsoft Azure subscription ID.


 
dataCenterId
required
string
Microsoft Azure 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.1
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/azure/ipAddresses
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Veeam Cloud Connect Site IP Addresses
Returns a resource representation of all IP addresses assigned in Microsoft Azure to 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.1
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/azure/backupServerIpAddresses
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get All Microsoft Azure Cryptographic Keys
Returns a collection resource representation of all Microsoft Azure cryptographic keys 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
connectionUid
required
string <uuid> 
Microsoft Azure connection UID.


 
subscriptionId
required
string
Microsoft Azure subscription 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.1
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/azure/keys
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Microsoft Azure Cryptographic Key
Creates a Microsoft Azure cryptographic key 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.1
Request Body schema: application/json
required
connectionUid
required
string <uuid> 
UID assigned to a Microsoft Azure connection.


 
keyPairName
required
string
Name of a key pair.


 
subscriptionId
required
string
ID assigned to a Microsoft Azure subscription.


 
dataCenterId
required
string
ID assigned to a Microsoft Azure datacenter.


 
resourceGroupName
required
string
Name of a resource group.


 
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/azure/keys
Request samples 
application/json
{
  • "connectionUid": "da21b612-7f14-46cd-b32f-ec9407212147",
  • "subscriptionId": "8126721b-6b4a-4647-bbd2-259ebf802ff7",
  • "dataCenterId": "997c5444-8786-48ec-be2a-c3f80a535dfd",
  • "resourceGroupName": "rg-ct-management",
  • "keyPairName": "dma-vspc-azure-pc-plugin"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get All Microsoft Azure Security Groups
Returns a collection resource representation of all Microsoft Azure network security groups 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
connectionUid
required
string <uuid> 
Microsoft Azure connection UID.


 
subscriptionId
required
string
Microsoft Azure subscription ID.


 
dataCenterId
required
string
Microsot Azure 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.1
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/azure/securityGroups
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Microsoft Azure Datacenters
Returns a collection resource representation of all Microsoft Azure datacenters 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
connectionUid
required
string <uuid> 
Microsoft Azure connection UID.


 
subscriptionId
required
string
Microsoft Azure subscription 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.1
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/azure/dataCenters
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Microsoft Azure Resource Groups
Returns a collection resource representation of all Microsoft Azure resource groups 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
connectionUid
required
string <uuid> 
Microsoft Azure connection UID.


 
subscriptionId
required
string
Microsoft Azure subscription 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.1
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/azure/resourceGroups
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Microsoft Azure VMs
Returns a collection resource representation of all Microsoft Azure 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
connectionUid
required
string <uuid> 
Microsoft Azure connection UID.


 
subscriptionId
required
string
Microsoft Azure subscription ID.


 
dataCenterId
required
string
Microsoft Azure 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.1
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/azure/virtualMachines
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Connect Veeam Backup for Microsoft Azure Appliance
Connect an existing Veeam Backup for Microsoft Azure 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.1
Request Body schema: application/json
required
required
object
 
required
object
 
required
object
 
object or null
 
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/azure/appliances/connect
Request samples 
application/json
{
  • "account": {
    },
  • "virtualMachine": {
    },
  • "network": null,
  • "guestOsCredentials": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Create Veeam Backup for Microsoft Azure Appliance
Creates a new Veeam Backup for Microsoft Azure appliance regitered 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.1
Request Body schema: application/json
required
required
object
 
required
object
 
required
object
 
required
object
 
object or null
Veeam Backup for Public Clouds appliance network resources.




If you send 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/azure/appliances/deploy
Request samples 
application/json
{
  • "account": {
    },
  • "virtualMachine": {
    },
  • "network": {
    },
  • "ipAddress": {
    },
  • "guestOsCredentials": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Veeam Backup for Microsoft Azure Appliance
Returns a resource representation of a Veeam Backup for Microsoft Azure appliance with the specified UID.


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


 
applianceUid
required
string <uuid> 
Veeam Backup for Microsoft Azure 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.1
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/azure/appliances/{applianceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Veeam Backup for Microsoft Azure Appliance
Modifies a Veeam Backup for Microsoft Azure appliance with the specified UID.


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


 
applianceUid
required
string <uuid> 
Veeam Backup for Microsoft Azure 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.1
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/azure/appliances/{applianceUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}

    
    

                                

                                    
Document updated 11/06/2025
Page content applies to build 9.1.0.30345