Get All Cloud Gateway Pools
You can get a collection resource representation of all cloud gateway pools.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator.
Request
To get a representation of all cloud gateway pools, send the GET HTTP request to the URL of the /infrastructure/sites/cloudgatewaypools collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/sites/cloudgatewaypools |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
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 Service Provider Console returns a collection resource representation based on the CloudGatewayPool schema.
Example 
The following request returns a representation of all cloud gateway pools.
Request: GET https://localhost:1280/api/v3/infrastructure/sites/cloudgatewaypools
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "e1135752-d497-43e0-8857-8a0caa262e2e", "name": "Cloud gateway pool 1", "backupServerUid": "365be228-b14d-421a-9a0e-a1a434e2195c", "numberOfGateways": 3 }, { "instanceUid": "412ca00e-fe63-464d-8816-e89b0fabd0a5", "name": "Cloud gateway pool 2", "backupServerUid": "b3dbc951-f45b-413e-9419-287dd8626748", "numberOfGateways": 5 } ] } |
