Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
RESTful API Reference

(PUT) /cloud/gatewayPools/{ID}

Edits settings of a gateway pool with the specified ID.

Request

To edit settings of the gateway pool, you need to send the PUT HTTP request to the URL of the /cloud/gatewayPools/{ID} resource.

HTTP Request

PUT http://<Enterprise-Manager>:9399/api/cloud/gatewayPools/{ID}

Request Headers

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:

  • application/xml
  • application/json

Request Body

In the request body, the client must send parameters for the gateway pool which settings must be updated. 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
GatewayListType

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
TenantListType

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:

<?xml version="1.0" encoding="utf-8"?>
<CloudGatewayPool Href="http://localhost:9399/api/cloud/gatewayPools/dcdca4d9-f850-4094-813e-f1aa9ba8bcfb?format=Entity" Type="CloudGatewayPool" Name="Cloud gateway pool 1" UID="urn:veeam:CloudGatewayPool:dcdca4d9-f850-4094-813e-f1aa9ba8bcfb" 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">
 <Description>Created by Administrator</Description>
 <CloudGateways>
   <CloudGatewayUid>urn:veeam:CloudGateway:d59b541c-c7e0-4179-af6d-e78eac78e893</CloudGatewayUid>
 </CloudGateways>
 <CloudTenants/>
</CloudGatewayPool>

Cloud Gateways Settings

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>
   <CloudGatewayUid>urn:veeam:CloudGateway:0eade4fd-0b0c-4ce4-8c1f-ca60ec682d0e</CloudGatewayUid>
 </CloudGateways>

Cloud Tenant Settings

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>
   <CloudTenantUid>urn:veeam:CloudTenant:5cf540af-512a-5ba8-9f12-77fba51207e0</CloudTenantUid>
 </CloudTenants>

Query Parameters

None.

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:

  • application/xml
  • application/json

Response Body

None.

Example

The example below updates the description and password settings for the gateway pool with ID 4f90635a-7ecc-49fe-beb6-60b37eb4bd89.

Request:

PUT http://localhost:9399/api/cloud/gatewayPools/4f90635a-7ecc-49fe-beb6-60b37eb4bd89

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Request Body:

<?xml version="1.0" encoding="utf-8"?>
<CloudGatewayPool Href="http://localhost:9399/api/cloud/gatewayPools/4f90635a-7ecc-49fe-beb6-60b37eb4bd89?format=Entity" Type="CloudGatewayPool" Name="Cloud gateway pool 1" UID="urn:veeam:CloudGatewayPool:dcdca4d9-f850-4094-813e-f1aa9ba8bcfb" 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">
 <Description>Created by Administrator</Description>
 <CloudGateways>
   <CloudGatewayUid>urn:veeam:CloudGateway:d59b541c-c7e0-4179-af6d-e78eac78e893</CloudGatewayUid>
 </CloudGateways>
 <CloudTenants/>
</CloudGatewayPool>

Response:

202 Accepted

 

Response Body:

<?xml version="1.0" encoding="utf-8"?>
<Task 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" Href="http://localhost:9399/api/tasks/task-2" Type="Task">
 <Links>
   <Link Href="http://localhost:9399/api/tasks/task-2" Rel="Delete"/>
 </Links>
 <TaskId>task-2</TaskId>
 <State>Running</State>
 <Operation>UpdateCloudGatewayPool</Operation>
</Task>

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-2

 

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-2">
 <Links>
   <Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-2" />
 </Links>
 <TaskId>task-2</TaskId>
 <State>Finished</State>
 <Operation>UpdateCloudGatewayPool</Operation>
 <Result Success="true">
   <Message>Ok</Message>
 </Result>
</Task>

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions Reference

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation