Configures a new cloud gateway pool on the Veeam backup server connected to Veeam Backup Enterprise Manager.
To configure a cloud gateway pool, Veeam Backup & Replication needs at least one cloud gateway assigned to a managed backup server.
Request
To create a new cloud gateway pool, you need to send the POST HTTP request to the URL of the /cloud/gatewayPools resource.
HTTP Request
POST http://<Enterprise-Manager>:9399/api/cloud/gatewayPools |
Request Header
The request contains the following headers:
Header | Required | Description |
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security. |
Accept | False | The request requires a certain format in response. In the header, the client can specify one of the following formats:
|
Request Body
In the request body, the client must send parameters for the new cloud gateway pool. The body of the request must conform to the XML Schema Definition of Veeam Backup Enterprise Manager RESTful API.
The request body must contain the following elements:
Element | Type | Description | Modifiable | Min/Max Occurrence |
Name | String | Specifies the name of the created cloud gateway pool. | Yes | 1/1 |
Description | String | Description for the created cloud gateway pool. | Yes | 0/1 |
CloudGateways | CloudGatewayPool | This parameter specifies the list of the cloud gateways included in the cloud gateway pool. At least one cloud gateway must be specified in order to create a cloud gateway pool. For more information, see Cloud Gateway Settings. | Yes | 1/1 |
CloudTenants | CloudGatewayPool | This parameter specifies a list of cloud tenants that the created cloud gateway pool will be assigned to. This parameter is optional, as a gateway pool can be assigned to no tenants. For more information, see Cloud Tenant Settings. | Yes | 0/1 |
BackupServerUid | URN | UID of the Veeam backup server on which the cloud gateway pool must be created. | Yes | 1/1 |
For example:
<CreateCloudGatewayPoolSpec 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"> |
You can define the following parameters:
Element | Type | Description | Modifiable | Min/Max Occurrence |
CloudGatewayUid | URN | UID name of the cloud gateway included in the created cloud gateway pool. Can be taken from cloud/gateways. | Yes | 1/Unbounded |
For example:
<CloudGateways> |
You can define the following parameters:
Element | Type | Description | Modifiable | Min/Max Occurrence |
CloudTenantUid | URN | UID name of a cloud tenant that the created cloud gateway pool will be assigned to. Can be taken from cloud/tenants. | Yes | 1/Unbounded |
For example:
<CloudTenants> |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 202 Accepted.
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. Possible values:
|
Response Body
None.
Example
The example below creates a cloud gateway pool on the Veeam backup server having UID urn:veeam:BackupServer:29e5d158-1f58-44bc-bbaa-2752d787a91d.
Request: POST http://localhost:9399/api/cloud/gatewayPools
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Request Body: <?xml version="1.0" encoding="utf-8"?>
Response: 202 Accepted
Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1"> |
To trace the status of the operation, send the GET HTTP request to the URL of the received task resource:
Request: GET http://localhost:9399/api/tasks/task-1
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 Success
Response Body: <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1"> |
