Veeam Service Provider Console 9.1
REST API Reference
Related documents

Public Cloud

This resource collection represents public cloud entities connected to Veeam Service Provider Console.

Get Veeam Backup for Public Clouds Appliance Mapping

Returns a resource representation of organization mapping of a Veeam Backup for Public Clouds appliance with the specified UID.

Request
path Parameters
applianceUid
required
string <uuid>

Veeam Backup for Public Clouds 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/publicCloud/appliances/{applianceUid}/mapping
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Create Veeam Backup for Public Clouds Appliance Mapping
Maps a Veeam Backup for Public Clouds appliance to an organization.


Request 
path Parameters
applianceUid
required
string <uuid> 
Veeam Backup for Public Clouds 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
companyUid
required
string <uuid> 
UID assigned to a company.


 
guestOsCredentialsUid
required
string <uuid> 
UID assigned to guest OS credentials record.


 
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/appliances/{applianceUid}/mapping
Request samples 
application/json
{
  • "companyUid": "6eb51175-0421-4d72-bc5b-f4ebb137eb40",
  • "guestOsCredentialsUid": "bfdcd0bb-97b1-4c24-ad82-2f2a2496bd8b"
}
Response samples 
application/json
{
  • "data": {
    }
}
Delete Veeam Backup for Public Clouds Appliance Mapping
Deletes an organization mapping of a Veeam Backup for Public Clouds appliance with the specified UID.


Request 
path Parameters
applianceUid
required
string <uuid> 
Veeam Backup for Public Clouds appliance 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/publicCloud/appliances/{applianceUid}/mapping
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Veeam Backup for Public Clouds Appliance Certificate
Returns a resource representation of a security certificate of a Veeam Backup for Public Clouds appliance with the specified UID.


Request 
path Parameters
applianceUid
required
string <uuid> 
Veeam Backup for Public Clouds 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/publicCloud/appliances/{applianceUid}/certificate
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Verify Veeam Backup for Public Clouds Appliance Certificate
Verifies a security certificate of a Veeam Backup for Public Clouds appliance with the specified UID.


Request 
path Parameters
applianceUid
required
string <uuid> 
Veeam Backup for Public Clouds appliance 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
Request Body schema: application/json
required
username
required
string  [ 1 .. 255 ] characters 
User name.


 
password
required
string  <= 1024 characters 
Password.


 
certificateThumbprint
required
string  <= 128 characters 
Security certificate thumbprint.


 
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/appliances/{applianceUid}/certificate/verify
Request samples 
application/json
{
  • "username": "s.smith",
  • "password": "Password1",
  • "certificateThumbprint": "4D55401A6BE5D2B5098A3FC8C782B47DCA56C3E5"
}
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Synchronize Public Cloud Accounts
Initiates synchronization of public cloud account data between Veeam Service Provider Console and Veeam Backup for Public Cloud.


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.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/publicCloud/accounts/sync
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Public Cloud Time Zones
Returns a collection resource representation of all time zones of public 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
publicCloudType
required
string
Platform type of public cloud VMs.


 Enum: "AWS" "Azure" "Google"  
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/timeZones
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Guest OS Credentials
Creates guest OS credentials for public cloud VMs.


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.1
Request Body schema: application/json
required
password
required
string <password>   [ 8 .. 1024 ] characters 
Password.


 
username
required
string  [ 1 .. 255 ] characters 
User name.


 
role
required
string
Role of a user.


 Enum: "serviceProviderAdministrator" "companyAdministrator"  
description
string or null  <= 250 characters 
Description of a user.


 
siteUid
string or null <uuid> 
Veeam Cloud Connect site UID.


 
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/guestOsCredentials
Request samples 
application/json
{
  • "role": "serviceProviderAdministrator",
  • "username": "admin",
  • "description": "Service Provider Admin Credentials",
  • "password": "Password1",
  • "siteUid": "e5d94dfc-0861-42ef-b929-7265eead92cc"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get All Guest OS Credentials
Returns a collection resource representation of all guest OS credentials for public cloud VMs.


Request 
query Parameters
siteUid
string <uuid> 
Veeam Cloud Connect site UID. Limits returned guest OS credentials to those used to access VMs registered on the specified Veeam Cloud Connect site.


 
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/publicCloud/guestOsCredentials
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Guest OS Credentials Record
Returns a resource representation of public cloud guest OS credentials record with the specified UID.


Request 
path Parameters
guestOsCredentialsUid
required
string <uuid> 
Guest OS credentials record 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/publicCloud/guestOsCredentials/{guestOsCredentialsUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Guest OS Credentials Record
Modifies public cloud guest OS credentials record with the specified UID.


Request 
path Parameters
guestOsCredentialsUid
required
string <uuid> 
Guest OS credentials record 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/publicCloud/guestOsCredentials/{guestOsCredentialsUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Guest OS Credentials Record
Deletes public cloud guest OS credentials record with the specified UID.


Request 
path Parameters
guestOsCredentialsUid
required
string <uuid> 
Guest OS 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.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/publicCloud/guestOsCredentials/{guestOsCredentialsUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Synchronize Public Cloud Guest OS Credentials
Initiates synchronization of public cloud guest OS credentials data in Veeam Service Provider Console with Veeam Backup for Public Cloud.


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.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/publicCloud/guestOsCredentials/sync
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Public Cloud Repositories
Returns a collection resource representation of all public cloud repositories.


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.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/publicCloud/repositories
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Veeam Backup for Public Clouds Appliances Registered on All Veeam Cloud Connect Sites
Returns a collection resource representation of Veeam Backup for Public Clouds appliances registered on all Veeam Cloud Connect sites.


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.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/publicCloud/appliances
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Veeam Backup for Public Clouds Appliances Registered on Veeam Cloud Connect Site
Returns a collection resource representation of all 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 (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/appliances
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Veeam Backup for Public Clouds Appliance Registered on Veeam Cloud Connect Site
Returns a resource representation of a Veeam Backup for Public Clouds appliance with the specified UID registered on a Veeam Cloud Connect site.


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


 
applianceUid
required
string <uuid> 
Veeam Backup for Public Clouds 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/appliances/{applianceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Delete Veeam Backup for Public Clouds Appliance Registered on Veeam Cloud Connect Site
Removes a Veeam Backup for Public Clouds appliance with the specified UID registered on a Veeam Cloud Connect site.


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


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


 
query Parameters
withCloudResources
required
boolean
Defines whether cloud resources must be deleted along with Veeam Backup for Public Clouds appliance data.


 
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/appliances/{applianceUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Upgrade Veeam Backup for Public Clouds Appliance Registered on Veeam Cloud Connect Site
Upgrades a Veeam Backup for Public Clouds appliance with the specified UID registered on a Veeam Cloud Connect site.


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


 
applianceUid
required
string <uuid> 
Veeam Backup for Public Clouds appliance 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.


post/infrastructure/sites/{siteUid}/publicCloud/appliances/{applianceUid}/upgrade
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Collect Data From Veeam Backup for Public Clouds Appliance Registered on Veeam Cloud Connect Site.
Initiates data collection from a Veeam Backup for Public Clouds appliance with the specified UID registered on a Veeam Cloud Connect site.


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


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


 
query Parameters
fullRecollect
boolean
 Default:  false
Indicates whether full data recollect must be performed.


 
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/appliances/{applianceUid}/collect
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Veeam Backup for Public Clouds Appliance Repositories Registered on Veeam Cloud Connect Site
Returns a collection resource representation of repositories created by a Veeam Backup for Public Clouds appliance with the specified UID registered on a Veeam Cloud Connect Site.


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


 
applianceUid
required
string <uuid> 
Veeam Backup for Public Clouds appliance 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/appliances/{applianceUid}/repositories
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Veeam Backup for Public Clouds Appliances.
Returns a collection resource representation of all Veeam Backup for Public Clouds appliances.


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.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/backupServers/publicCloud/appliances
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Veeam Backup for Public Clouds Appliances Registered on Veeam Backup & Replication Server
Returns a collection resource representation of all Veeam Backup for Public Clouds appliances 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
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/backupServers/{backupServerUid}/publicCloud/appliances
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Veeam Backup for Public Clouds Appliance
Returns a resource representation of a Veeam Backup for Public Clouds appliance with the specified UID.


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


 
applianceUid
required
string <uuid> 
Veeam Backup for Public Clouds 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/backupServers/{backupServerUid}/publicCloud/appliances/{applianceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Collect Data From Veeam Backup for Public Clouds Appliance
Initiates data collection from a Veeam Backup for Public Clouds appliance with the specified UID.


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


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


 
query Parameters
fullRecollect
boolean
 Default:  false
Indicates whether full data recollect must be performed.


 
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/backupServers/{backupServerUid}/publicCloud/appliances/{applianceUid}/collect
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}

    
    

                                

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