Cloud Connect Service

In this article

    Service providers can use Veeam Backup Enterprise Manager REST 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="https://localhost:9398/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="https://localhost:9398/api/logonSessions/64cf72ba-27a3-4a19-b073-310e16042509" Type="LogonSession" Rel="Up"/>
       <Link Href="https://localhost:9398/api/cloud/gateways" Type="CloudGatewayReferenceList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/tenants" Type="CloudTenantReferenceList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/hardwarePlans" Type="CloudHardwarePlanReferenceList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/publicIpAddresses" Type="CloudPublicIpAddressReferenceList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/cloudFailoverPlans" Type="CloudFailoverPlanReferenceList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/vmReplicaPoints" Type="CloudVmReplicaPointReferenceList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/replicas" Type="CloudReplicaReferenceList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/vlans" Type="VlanConfigurationReferenceList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/failoverSessions" Type="CloudFailoverSessionReferenceList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/gatewayPools" Type="CloudGatewayPoolReferenceList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/gateways?format=Entity" Type="CloudGatewayList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/tenants?format=Entity" Type="CloudTenantList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/hardwarePlans?format=Entity" Type="CloudHardwarePlanList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/publicIpAddresses?format=Entity" Type="CloudPublicIpAddressList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/cloudFailoverPlans?format=Entity" Type="CloudFailoverPlanList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/vmReplicaPoints?format=Entity" Type="CloudVmReplicaPointList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/replicas?format=Entity" Type="CloudReplicaList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/vlans?format=Entity" Type="VlanConfigurationList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/failoverSessions?format=Entity" Type="CloudFailoverSessionList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/gatewayPools?format=Entity" Type="CloudGatewayPoolList" Rel="Down"/>
       <Link Href="https://localhost:9398/api/cloud/gateways" Rel="Create"/>
       <Link Href="https://localhost:9398/api/cloud/tenants" Rel="Create"/>
       <Link Href="https://localhost:9398/api/cloud/hardwarePlans" Rel="Create"/>
       <Link Href="https://localhost:9398/api/cloud/publicIpAddresses" Rel="Create"/>
       <Link Href="https://localhost:9398/api/cloud/gatewayPools" Rel="Create"/>
     </Links>
    </CloudConnectService>

     

    Note

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