Veeam Cloud Connect

This resource collection represents monitored Veeam Cloud Connect infrastructure.

Get All Cloud Gateways

Returns a collection resource representation of all cloud gateways.

SecurityBearer

Request

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Responses

200

Success

403

Forbidden

get/api/v2.3/cloudConnect/cloudGateways

Request samples

curl

Response samples

application/json

{"items": [{"cloudGatewayId": 102,
"cloudGatewayUidInVbr": "bab6ca01-e213-45ed-88fd-8f219d81b4cd",
"name": "srv12.tech.local",
"backupServerId": 101,
"gatewayPoolId": null,
"enabled": true,
"port": 6180,
"ip": "srv12.tech.local",
"state": "Healthy",
"upgradeRequired": false
},
{"cloudGatewayId": 103,
"cloudGatewayUidInVbr": "e22507f6-fc7d-4446-bdeb-e09670d001bc",
"name": "srv13",
"backupServerId": 101,
"gatewayPoolId": null,
"enabled": true,
"port": 6180,
"ip": "srv13.tech.local",
"state": "Healthy",
"upgradeRequired": false
}
],
"totalCount": 2
}

Get Cloud Gateway

Returns a resource representation of a cloud gateway with the specified ID.

SecurityBearer

Request

path Parameters

cloudGatewayId

required

integer <int64>

Responses

200

Success

403

Forbidden

get/api/v2.3/cloudConnect/cloudGateways/{cloudGatewayId}

Request samples

curl

Response samples

application/json

{"cloudGatewayId": 103,
"cloudGatewayUidInVbr": "e22507f6-fc7d-4446-bdeb-e09670d001bc",
"name": "srv13",
"backupServerId": 101,
"gatewayPoolId": null,
"enabled": true,
"port": 6180,
"ip": "srv13.tech.local",
"state": "Healthy",
"upgradeRequired": false
}

Get All Cloud Gateway Pools

Returns a collection resource representation of all cloud gateway pools.

SecurityBearer

Request

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Responses

200

Success

403

Forbidden

get/api/v2.3/cloudConnect/cloudGatewayPools

Request samples

curl

Response samples

application/json

{"items": [{"cloudGatewayPoolId": 47,
"cloudGatewayPoolUidInVbr": "2df959dc-e36e-4b48-bda8-5cfb2965d153",
"name": "Alpha Pool",
"backupServerId": 413,
"description": "Alpha Cloud Gateway Pool",
"gatewayCount": 6
},
{"cloudGatewayPoolId": 53,
"cloudGatewayPoolUidInVbr": "f7452816-3797-4f5b-8644-b631016cf92b",
"name": "Beta Pool",
"backupServerId": 245,
"description": "Beta Cloud Gateway Pool",
"gatewayCount": 4
}
],
"totalCount": 2
}

Get Cloud Gateway Pool

Returns a resource representation of a cloud gateway pool with the specified ID.

SecurityBearer

Request

path Parameters

cloudGatewayPoolId

required

integer <int64>

Responses

200

Success

403

Forbidden

get/api/v2.3/cloudConnect/cloudGatewayPools/{cloudGatewayPoolId}

Request samples

curl

Response samples

application/json

{"cloudGatewayPoolId": 47,
"cloudGatewayPoolUidInVbr": "2df959dc-e36e-4b48-bda8-5cfb2965d153",
"name": "Alpha Pool",
"backupServerId": 413,
"description": "Alpha Cloud Gateway Pool",
"gatewayCount": 6
}

Get All Tenants

Returns a collection resource representation of all Veeam Cloud Connect tenants.

SecurityBearer

Request

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Responses

200

Success

403

Forbidden

get/api/v2.3/cloudConnect/tenants

Request samples

curl

Response samples

application/json

{"items": [{"tenantId": 121,
"tenantUidInVbr": "11e8473a-87d5-4d76-ab2a-3d15d8bca95a",
"backupServerId": 101,
"name": "ABC Company",
"type": "Standalone",
"tenantContractExpirationDate": null
},
{"tenantId": 122,
"tenantUidInVbr": "26ff76f8-97c4-43a7-89ed-01f50b151090",
"backupServerId": 101,
"name": "Omega",
"type": "Standalone",
"tenantContractExpirationDate": null
},
{"tenantId": 123,
"tenantUidInVbr": "30d18d6f-0e91-49c9-a8fa-a3d4f0d622a0",
"backupServerId": 101,
"name": "Beta Systems",
"type": "Standalone",
"tenantContractExpirationDate": null
},
{"tenantId": 219,
"tenantUidInVbr": "7c651153-7714-4cc7-b658-fd68460bfe05",
"backupServerId": 101,
"name": "tech\\william.fox",
"type": "ActiveDirectory",
"tenantContractExpirationDate": null
}
],
"totalCount": 4
}

Get Tenant

Returns a resource representation of a Veeam Cloud Connect tenant with the specified ID.

SecurityBearer

Request

path Parameters

tenantId

required

integer <int64>

Responses

200

Success

403

Forbidden

get/api/v2.3/cloudConnect/tenants/{tenantId}

Request samples

curl

Response samples

application/json

{"tenantId": 123,
"tenantUidInVbr": "30d18d6f-0e91-49c9-a8fa-a3d4f0d622a0",
"backupServerId": 101,
"name": "Beta Systems",
"type": "Standalone",
"tenantContractExpirationDate": null
}

Get All Tenant Quotas

Returns a collection resource representation of quotas configured for all Veeam Cloud Connect tenants.

SecurityBearer

Request

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Responses

200

Success

403

Forbidden

get/api/v2.3/cloudConnect/tenants/tenantQuotas

Request samples

curl

Response samples

application/json

{"items": [{"tenantQuotaId": 124,
"tenantQuotaUidInVbr": "028edb91-e0e6-418a-9e29-b1200f90fd9f",
"tenantId": 121,
"backupServerId": 101,
"quotaMb": 102400,
"usedQuotaMb": 69922,
"protectedVmsCount": 1,
"lastBackupActivityTime": "2025-07-11T22:11:18Z",
"serversCount": 5,
"workstationsCount": 1
},
{"tenantQuotaId": 125,
"tenantQuotaUidInVbr": "721c3524-a876-4e4b-bb4b-760b18bb8cbf",
"tenantId": 122,
"backupServerId": 101,
"quotaMb": 102400,
"usedQuotaMb": 0,
"protectedVmsCount": 0,
"lastBackupActivityTime": null,
"serversCount": 0,
"workstationsCount": 0
},
{"tenantQuotaId": 126,
"tenantQuotaUidInVbr": "bc138efc-a498-4693-8427-1dbb4646c4f0",
"tenantId": 123,
"backupServerId": 101,
"quotaMb": 102400,
"usedQuotaMb": 0,
"protectedVmsCount": 0,
"lastBackupActivityTime": null,
"serversCount": 0,
"workstationsCount": 0
},
{"tenantQuotaId": 218,
"tenantQuotaUidInVbr": "0ee02875-4fac-42b0-a8d4-c6a01ec1a878",
"tenantId": 121,
"backupServerId": 101,
"quotaMb": 102400,
"usedQuotaMb": 0,
"protectedVmsCount": 0,
"lastBackupActivityTime": "2023-01-26T17:39:45Z",
"serversCount": 0,
"workstationsCount": 0
}
],
"totalCount": 4
}

Get All Quotas of Tenant

Returns a collection resource representation of all quotas configured for a Veeam Cloud Connect tenant with the specified ID.

SecurityBearer

Request

path Parameters

tenantId

required

integer <int64>

query Parameters

Offset	integer <int32> Default: 0
Limit	integer <int32> Default: 100
Filter	string
Sort	string
Select	string

Responses

200

Success

403

Forbidden

get/api/v2.3/cloudConnect/tenants/{tenantId}/tenantQuotas

Request samples

curl

Response samples

application/json

{"items": [{"tenantQuotaId": 124,
"tenantQuotaUidInVbr": "028edb91-e0e6-418a-9e29-b1200f90fd9f",
"tenantId": 121,
"backupServerId": 101,
"quotaMb": 102400,
"usedQuotaMb": 69922,
"protectedVmsCount": 1,
"lastBackupActivityTime": "2025-07-11T22:11:18Z",
"serversCount": 5,
"workstationsCount": 1
},
{"tenantQuotaId": 218,
"tenantQuotaUidInVbr": "0ee02875-4fac-42b0-a8d4-c6a01ec1a878",
"tenantId": 121,
"backupServerId": 101,
"quotaMb": 102400,
"usedQuotaMb": 0,
"protectedVmsCount": 0,
"lastBackupActivityTime": "2023-01-26T17:39:45Z",
"serversCount": 0,
"workstationsCount": 0
}
],
"totalCount": 2
}