This is an archive version of the document. To get the most up-to-date information, see the current version.Get Cloud Gateway Pools
You can get a representation of a collection of all cloud gateway pools.
Request
To get all cloud gateway pools in Veeam Availability Console, send the GET HTTPS request to the URL of the /cloudGatewayPools collection.
HTTP Request
GET https://<Availability-Console>:1281/v2/cloudGatewayPools |
Request Headers
The request header must contain the authorization token for the current logon session.
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 Success.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Availability Console returns a representation of the /cloudGatewayPools collection.
Example 
The following request returns all cloud gateway pools available in Veeam Availability Console.
Request: GET https://localhost:1281/v2/cloudGatewayPools
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 Success
Response Body: [ { "instanceUid": "a8d8032d-534d-4945-844d-cafe51869747", "name": "Alpha Pool", "numberOfGateways": 7, "cloudAgentUid": "6e8b485b-c729-4c26-94d6-bc843b4f645e", "_links": [ { "rel": "self", "method": "GET", "href": "https://vac:1281/v2/cloudGatewayPools/a8d8032d-534d-4945-844d-cafe51869747" } ] }, { "instanceUid": "02d73fed-3ca6-434d-a5d2-33fe6ea59461", "name": "Delta Pool", "numberOfGateways": 5, "cloudAgentUid": "680d80da-01ca-4e87-ad53-4a4e10b22b9a", "_links": [ { "rel": "self", "method": "GET", "href": "https://vac:1281/v2/cloudGatewayPools/02d73fed-3ca6-434d-a5d2-33fe6ea59461" } ] } ] |