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

(POST) /cloud/publicIpAddresses

Adds one or several public IP addresses to the pool of public IP addresses configured on the Veeam backup server connected to Veeam Backup Enterprise Manager.

Request

To add one or several public IP addresses to the pool of public IP addresses, you need to send the POST HTTP request to the URL of the /cloud/publicIpAddresses resource.

HTTP Request

POST http://<Enterprise-Manager>:9399/api/cloud/publicIpAddresses

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.

Request Body

In the request body, the client must send parameters for the new public IP address range. 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

BackupServerUid

URN

ID of the Veeam backup server on which the pool of public IP addresses must be configured.

No

1/1

IpAddressLowerBound

String

The first IP address in the range of public IP addresses added to the pool.

Yes

1/1

IpAddressUpperBound

String

The last IP address in the range of public IP addresses added to the pool.

Yes

1/1

For example:

<?xml version="1.0" encoding="utf-8"?>
<CloudPublicIpAddressCreateSpec 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">
 <BackupServerUid>urn:veeam:BackupServer:8fff3b8e-c3f1-4ef5-aecc-561f07bf9982
</BackupServerUid>
 <IpAddressLowerBound>198.51.100.11</IpAddressLowerBound>
 <IpAddressUpperBound>198.51.100.15</IpAddressUpperBound>
</CloudPublicIpAddressCreateSpec>

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: application/xml.

Response Body

None.

Example

The example adds a range of public IP addresses to the pool of public IP addresses on the Veeam backup server with ID 8fff3b8e-c3f1-4ef5-aecc-561f07bf9982.

Request:

POST http://localhost:9399/api/cloud/publicIpAddresses

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Request Body:

<?xml version="1.0" encoding="utf-8"?>
<CloudPublicIpAddressCreateSpec 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">
 <BackupServerUid>urn:veeam:BackupServer:8fff3b8e-c3f1-4ef5-aecc-561f07bf9982
</BackupServerUid>
 <IpAddressLowerBound>198.51.100.11</IpAddressLowerBound>
 <IpAddressUpperBound>198.51.100.15</IpAddressUpperBound>
</CloudPublicIpAddressCreateSpec>

 

Response:

202 Accepted

 

Response Body:

<Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1">
 <Links>
   <Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Running</State>
 <Operation>CreateCloudPublicIpAddress</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-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">
 <Links>
   <Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
   <Link Rel="Related" Type="CloudPublicIpAddressList" Href="http://localhost:9399/api/cloud/publicIpAddresses?format=Entity" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Finished</State>
 <Operation>CreateCloudPublicIpAddress</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 Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation