This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /cloud/publicIpAddresses/{ID}
Returns a resource representation of a public IP address that has the specified ID.
Request
To get a resource representation of the public IP address, you need to send the GET HTTP request to the URL of the /cloud/publicIpAddresses/{ID} resource:
HTTP Request
or
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 | 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. |
Request Body
None.
Query Parameters
The following parameters can be used in queries:
Parameter | Type | Description | Can Be Used for Filtering | Can Be Used for Sorting |
|---|---|---|---|---|
Uid | URN | ID of the public IP address resource, for example: urn:veeam:CloudPublicIpAddress:22d2cdad-ddd1-4789-9e27-03bf25786648. | True | True |
Name | String | Name of the public IP address resource, for example: 198.51.100.16. | True | True |
IpAddress | String | Public IP address, for example: 198.51.100.16. | True | True |
CloudTenantUid | URN | ID of the tenant account to which the public IP address is assigned, for example: urn:veeam:CloudTenant:4f90635a-7ecc-49fe-beb6-60b37eb4bd89. | True | True |
CloudTenantName | String | Name of the tenant account to which the public IP address is assigned, for example: Cloud Tenant. | True | True |
BackupServerUId | URN | ID of the Veeam backup server on which the pool of public IP addresses is configured. | True | True |
BackupServerName | String | Name of the Veeam backup server on which the pool of public IP addresses is configured. | True | True |
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:
|
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /cloud/publicIpAddresses/{ID} resource.
Example
The example below returns an entity representation of the public IP address resource that has ID 22d2cdad-ddd1-4789-9e27-03bf25786648.
Request: GET https://localhost:9398/api/cloud/publicIpAddresses/22d2cdad-ddd1-4789-9e27-03bf25786648
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <CloudPublicIpAddress xmlns="http://www.veeam.com/ent/v1.0" Type="CloudPublicIpAddress" Href="https://localhost:9398/api/cloud/publicIpAddresses/22d2cdad-ddd1-4789-9e27-03bf25786648?format=Entity" Name="198.51.100.16" UID="urn:veeam:CloudPublicIpAddress:22d2cdad-ddd1-4789-9e27-03bf25786648" BackupServerUid="urn:veeam:BackupServer:8fff3b8e-c3f1-4ef5-aecc-561f07bf9982"> |
