Veeam Backup & Replication 9.5 Update 4
RESTful API Reference
Related documents

Cloud Connect Service

Service providers can use Veeam Backup Enterprise Manager RESTful API to work with Veeam Cloud Connect resources. Veeam Cloud Connect resources URLs are grouped in the Cloud Connect service resource representation. The resource representation contains a set of links to the following resources:

  • CloudGateway
  • CloudTenant
  • CloudHardwarePlan
  • CloudPublicIpAddress
  • CloudFailoverPlan
  • CloudVmReplicaPoint
  • CloudReplica
  • VlanConfiguration
  • CloudFailoverSession
  • CloudGatewayPool
  • CloudFailoveredVm

The resource representation of the Cloud Connect service looks in the following way:

<CloudConnectService Href="http://localhost:9399/api/cloud" Type="CloudConnectService" xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <Links>
   <Link Href="http://localhost:9399/api/logonSessions/64cf72ba-27a3-4a19-b073-310e16042509" Type="LogonSession" Rel="Up"/>
   <Link Href="http://localhost:9399/api/cloud/gateways" Type="CloudGatewayReferenceList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/tenants" Type="CloudTenantReferenceList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/hardwarePlans" Type="CloudHardwarePlanReferenceList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/publicIpAddresses" Type="CloudPublicIpAddressReferenceList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/cloudFailoverPlans" Type="CloudFailoverPlanReferenceList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/vmReplicaPoints" Type="CloudVmReplicaPointReferenceList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/replicas" Type="CloudReplicaReferenceList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/vlans" Type="VlanConfigurationReferenceList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/failoverSessions" Type="CloudFailoverSessionReferenceList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/gatewayPools" Type="CloudGatewayPoolReferenceList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/gateways?format=Entity" Type="CloudGatewayList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/tenants?format=Entity" Type="CloudTenantList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/hardwarePlans?format=Entity" Type="CloudHardwarePlanList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/publicIpAddresses?format=Entity" Type="CloudPublicIpAddressList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/cloudFailoverPlans?format=Entity" Type="CloudFailoverPlanList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/vmReplicaPoints?format=Entity" Type="CloudVmReplicaPointList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/replicas?format=Entity" Type="CloudReplicaList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/vlans?format=Entity" Type="VlanConfigurationList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/failoverSessions?format=Entity" Type="CloudFailoverSessionList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/gatewayPools?format=Entity" Type="CloudGatewayPoolList" Rel="Down"/>
   <Link Href="http://localhost:9399/api/cloud/gateways" Rel="Create"/>
   <Link Href="http://localhost:9399/api/cloud/tenants" Rel="Create"/>
   <Link Href="http://localhost:9399/api/cloud/hardwarePlans" Rel="Create"/>
   <Link Href="http://localhost:9399/api/cloud/publicIpAddresses" Rel="Create"/>
   <Link Href="http://localhost:9399/api/cloud/gatewayPools" Rel="Create"/>
 </Links>
</CloudConnectService>

 

Cloud Connect Service Note:

Cloud Connect service resource appears in the list of available Veeam Backup Enterprise Manager RESTful API resources if the Veeam Cloud Connect service provider license is installed on the Veeam backup server.

 

This Document Help Center
User Guide for VMware vSphereUser Guide for Microsoft Hyper-VEnterprise Manager User GuideVeeam Cloud Connect GuideVeeam Agent Management GuideVeeam Explorers User GuideBackup and Restore of SQL Server DatabasesVeeam Plug-ins for Enterprise ApplicationsPowerShell ReferenceVeeam Explorers PowerShell ReferenceRESTful API ReferenceRequired Permissions ReferenceQuick Start Guide for VMware vSphereQuick Start Guide for Microsoft Hyper-VVeeam Backup for AWS DocumentationVeeam Availability for Nutanix AHV DocumentationVeeam Backup for Microsoft Office 365 DocumentationVeeam ONE DocumentationVeeam Agent for Windows DocumentationVeeam Agent for Linux DocumentationVeeam Management Pack Documentation
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.