Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Children Display
alltrue
styleh3
pageSuperb Cloud API

GET /virtual_machines/:virtual_machine_id/ip_addresses

Gets IP address assignments for specified VS

Sections:

Table of Contents
maxLevel4
minLevel2
includeResponse.*|JSON.*|XML.*|Explanation.*

Response Parameters

ip_address_joins – an array of all IP addresses, assigned to VS

ip_address _id – ID of IP address

created_at - the timestamp in DB when this record was created

updated_at - the timestamp in DB when this record was updated

ip_address – an array of IP address, assigned to the VS (for details see the Get List of Transactions section)

id – ID of the IP address join

network_interface_id - the ID of the network interface to which this IP address should be assigned

JSON Request example

Code Block
languagebash
themeRDark
 GET /virtual_machines/:virtual_machine_id/ip_addresses.json

JSON Response

Code Block
 [
    {
        "ip_address_join": {
            "created_at": "2015-08-28T19:05:45+00:00",
            "id": 987,
            "ip_address_id": 1234,
            "network_interface_id": 500,
            "updated_at": "2015-08-28T19:05:45+00:00",
            "ip_address": {
                "address": "66.148.117.49",
                "broadcast": "66.148.119.255",
                "created_at": "2015-07-30T01:35:54+00:00",
                "customer_network_id": null,
                "disallowed_primary": false,
                "gateway": "66.123.123.1",
                "hypervisor_id": null,
                "id": 1234,
                "ip_address_pool_id": null,
                "network_address": "66.123.123.0",
                "network_id": 1,
                "pxe": false,
                "updated_at": "2015-08-27T19:34:49+00:00",
                "user_id": null,
                "free": false,
                "netmask": "255.255.252.0"
            }
        }
    }
]

XML Request example

Code Block
languagebash
themeRDark
 GET /virtual_machines/:virtual_machine_id/ip_addresses.xml

XML Response example

Code Block
languagexml
 <?xml version="1.0" encoding="UTF-8"?>
<ip_address_joins type="array">
<ip_address_join>
<ip_address_id type="integer">5</ip_address_id>
<created_at type="datetime">2011-07-19T12:29:10Z</created_at>
<updated_at type="datetime">2011-07-19T12:29:10Z</updated_at>
<ip_address>
<netmask>255.255.255.240</netmask>
<disallowed_primary type="boolean">false</disallowed_primary>
<address>109.123.105.182</address>
<created_at type="datetime">2011-07-14T15:43:09Z</created_at>
<updated_at type="datetime">2011-07-14T15:43:09Z</updated_at>
<network_id type="integer">1</network_id>
<network_address>109.123.105.176</network_address>
<broadcast>109.123.105.191</broadcast>
<id type="integer">5</id>
<free type="boolean">false</free>
<gateway>109.123.105.177</gateway>
</ip_address>
<id type="integer">46</id>
<network_interface_id type="integer">34</network_interface_id>
</ip_address_join>
</ip_address_joins>