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.
To get a list of public IP addresses, send the GET HTTP request to the query with the type parameter set to CloudPublicIpAddress.
The request contains the following headers:
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.
Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format.
In the query, you can use the following parameters for filtering and sorting.
UID of the public IP address resource, for example: urn:veeam:CloudPublicIpAddress:22d2cdad-ddd1-4789-9e27-03bf25786648.
Name of the public IP address resource, for example: 198.51.100.16.
Public IP address, for example: 198.51.100.16.
UID of the tenant account to which the public IP address is assigned, for example: urn:veeam:CloudTenant:4f90635a-7ecc-49fe-beb6-60b37eb4bd89.
Name of the tenant account to which the public IP address is assigned, for example: Cloud Tenant.
UID of the backup server on which the pool of public IP addresses is configured.
Name of the backup server on which the pool of public IP addresses is configured.
The server returns the following response to the client.
A successfully completed operation returns response code 200 OK.
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
The length of the response body.
The media type and syntax of the request body message. Possible values:
In the response body, the REST API returns a representation of the /cloud/publicIpAddresses resource collection.
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.