GET /query?type=CloudPublicIpAddress

Returns a resource representation of a collection of public IP addresses allocated in the service provider's network infrastructure and specified in Veeam Backup & Replication settings on backup servers connected to Veeam Backup Enterprise Manager. For details, see /cloud/publicIpAddresses.

Request

To get a list of public IP addresses, send the GET HTTP request to the query with the type parameter set to CloudPublicIpAddress.

HTTP Request

GET https://<Enterprise-Manager>:9398/api/query?type=CloudPublicIpAddress

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. For details, see Authentication and Security.

Accept

False

Identifies the format of the response. Possible values:

  • application/xml — the client can send this value in the header to accept response in the XML format.
  • application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

Request Body

None.

Optional Parameters

In the query, you can use the following parameters for filtering and sorting.

Parameter

Type

Description

UID

UidType

UID of the public IP address resource, for example: urn:veeam:CloudPublicIpAddress:22d2cdad-ddd1-4789-9e27-03bf25786648.

Name

String

Name of the public IP address resource, for example: 198.51.100.16.

IpAddress

String

Public IP address, for example: 198.51.100.16.

CloudTenantUid

UidType

UID of the tenant account to which the public IP address is assigned, for example: urn:veeam:CloudTenant:4f90635a-7ecc-49fe-beb6-60b37eb4bd89.

CloudTenantName

String

Name of the tenant account to which the public IP address is assigned, for example: Cloud Tenant.

BackupServerUId

UidType

UID of the backup server on which the pool of public IP addresses is configured.

BackupServerName

String

Name of the backup server on which the pool of public IP addresses is configured.

Response

The server returns the following response to the client.

Response Codes

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. Possible values:

  • application/xml
  • application/json

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /cloud/publicIpAddresses resource collection.

Example

The example below returns an entity resource representation of a collection of IP addresses configured on the 172.24.31.67 backup server and assigned to the tenant with ID urn:veeam:CloudTenant:e38a8692-6816-443e-9052-7fa71ee7fd65. The results are ordered in the acceding order by the Name parameter.

Request:

GET https://localhost:9398/api/query?type=CloudPublicIpAddress&format=Entities&sortAsc=Name&filter=BackupServerName=="172.24.31.67";CloudTenantUid=="urn:veeam:CloudTenant:e38a8692-6816-443e-9052-7fa71ee7fd65"

 

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 OK

 

Response Body:

<QueryResult xmlns="http://www.veeam.com/ent/v1.0">
 <Entities>
   <CloudPublicIps>
     <CloudPublicIp Type="CloudPublicIpAddress" Href="https://localhost:9398/api/cloud/publicIpAddresses/48cdc208-f99a-4ff6-a100-6233dba00ece?format=Entity" Name="198.51.100.1" UID="urn:veeam:CloudPublicIpAddress:48cdc208-f99a-4ff6-a100-6233dba00ece" BackupServerUid="urn:veeam:BackupServer:ca19249e-e638-421a-ab22-68cb89b9009a">
       <Links>
         <Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/ca19249e-e638-421a-ab22-68cb89b9009a" Name="172.24.31.67" />
         <Link Rel="Alternate" Type="CloudPublicIpAddressReference" Href="https://localhost:9398/api/cloud/publicIpAddresses/48cdc208-f99a-4ff6-a100-6233dba00ece" Name="198.51.100.1" />
         <Link Rel="Edit" Type="CloudPublicIpAddressReference" Href="https://localhost:9398/api/cloud/publicIpAddresses/48cdc208-f99a-4ff6-a100-6233dba00ece" Name="198.51.100.1" />
         <Link Rel="Delete" Href="https://localhost:9398/api/cloud/publicIpAddresses/48cdc208-f99a-4ff6-a100-6233dba00ece" />
       </Links>
       <IpAddress>198.51.100.1</IpAddress>
       <TenantUid>urn:veeam:CloudTenant:e38a8692-6816-443e-9052-7fa71ee7fd65</TenantUid>
     </CloudPublicIp>
     <CloudPublicIp Type="CloudPublicIpAddress" Href="https://localhost:9398/api/cloud/publicIpAddresses/2710fec2-538a-48b5-bec2-d6abab999951?format=Entity" Name="198.51.100.2" UID="urn:veeam:CloudPublicIpAddress:2710fec2-538a-48b5-bec2-d6abab999951" BackupServerUid="urn:veeam:BackupServer:ca19249e-e638-421a-ab22-68cb89b9009a">
       <Links>
         <Link Rel="Up" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/ca19249e-e638-421a-ab22-68cb89b9009a" Name="172.24.31.67" />
         <Link Rel="Alternate" Type="CloudPublicIpAddressReference" Href="https://localhost:9398/api/cloud/publicIpAddresses/2710fec2-538a-48b5-bec2-d6abab999951" Name="198.51.100.2" />
         <Link Rel="Edit" Type="CloudPublicIpAddressReference" Href="https://localhost:9398/api/cloud/publicIpAddresses/2710fec2-538a-48b5-bec2-d6abab999951" Name="198.51.100.2" />
         <Link Rel="Delete" Href="https://localhost:9398/api/cloud/publicIpAddresses/2710fec2-538a-48b5-bec2-d6abab999951" />
       </Links>
       <IpAddress>198.51.100.2</IpAddress>
       <TenantUid>urn:veeam:CloudTenant:e38a8692-6816-443e-9052-7fa71ee7fd65</TenantUid>
     </CloudPublicIp>
   </CloudPublicIps>
 </Entities>
 <PagingInfo PagesCount="1" PageSize="100" PageNum="1">
   <Links>
     <Link Rel="First" Href="https://localhost:9398/api/query?type=CloudPublicIpAddress&format=Entities&sortAsc=Name&filter=BackupServerName=="172.24.31.67";CloudTenantUid=="urn:veeam:CloudTenant:e38a8692-6816-443e-9052-7fa71ee7fd65"&pageSize=100&page=1" />
     <Link Rel="Last" Href="https://localhost:9398/api/query?type=CloudPublicIpAddress&format=Entities&sortAsc=Name&filter=BackupServerName=="172.24.31.67";CloudTenantUid=="urn:veeam:CloudTenant:e38a8692-6816-443e-9052-7fa71ee7fd65"&pageSize=100&page=1" />
   </Links>
 </PagingInfo>
</QueryResult>