Server IP Justification

From INAP Dropzone API
(Difference between revisions)
Jump to: navigation, search
(Path)
Line 3: Line 3:
 
==Path==
 
==Path==
 
*/server/ip/justification/{$serverid}
 
*/server/ip/justification/{$serverid}
 +
 +
==Method==
 +
*[[glossary#get|GET]]
 +
 +
==Availability==
 +
*[[servers#Dedicated Server|Dedicated Server]]
 +
*[[servers#Dynamic Server|Dynamic Server]]
 +
*[[servers#Private Cloud|Private Cloud]]
 +
*[[servers#Public Cloud|Public Cloud]]
 +
 +
==Required Data Parameters==
 +
*{$serverid}: The server ID that is returned when using the [[Server List|list]] command.
 +
 +
==Optional Data Parameters==
 +
*None
 +
 +
==Returned Data==
 +
<pre>
 +
stdClass Object(
 +
  [success] => TRUE/FALSE
 +
  [data] => stdClass Object(
 +
  [public] => Array(
 +
      [0] => stdClass Object(
 +
        [ip_id] => The ID number of the assigned IP block.
 +
        [prefix] => The network IP address.
 +
        [cidr] => The CIDR of the assigned IP block.
 +
        [parent_id] =>
 +
        [parent_prefix] =>
 +
        [parent_cidr] =>
 +
        [uberid] =>
 +
        [assigned_to] => The ID number of the assigned server.
 +
        [staticrouting] =>
 +
        [last_router] => Hostname of the switch in the server rack.
 +
        [last_vlan] => The VLAN of the "last_router".
 +
        [last_destination] =>
 +
        [filterdev] =>
 +
        [guard_zone] =>
 +
        [hsrp_ip1] =>
 +
        [hsrp_ip2] =>
 +
        [netboot] =>
 +
        [spamscore] =>
 +
        [dc] => The datacenter the block of IP addresses belong to (dupont,cimco).
 +
        [updated] => The last time and date the IP information was updated.
 +
        [gateway] => The gateway IP address of the assigned IP block.
 +
        [ip] => The network IP address of the assigned IP block.
 +
        [netmask] => The subnet mask of the assigned IP block.
 +
        [wildcard] => Wildcard mask of the of the assigned IP block.
 +
        [broadcast] => The broadcast IP address of the assigned IP block.
 +
        [allips] => An array of all the IP addresses that are in the assignment.
 +
        [allusable] => An array of all the usable IP addresses that are in the assignment.
 +
        [firstip] => The first usable IP address that is in the assignment.
 +
        [secondip] => The second usable IP address that is in the assignment.
 +
        [lastip] => The last usable IP address that is in the assignment.
 +
        [range] => The range of usable IP addresses that are in the assignment.
 +
      )
 +
    )
 +
    [private] => stdClass Object(
 +
      [vlan_id] => The ID number of the assigned private network VLAN.
 +
      [dc] => The CIDR of the assigned IP block.
 +
      [vlan] => The number of the assigned VLAN.
 +
      [type] =>
 +
      [uberid] => The assigned client ID.
 +
      [name] =>
 +
      [networks] => Array(
 +
        [0] => stdClass Object(
 +
          [id] => The ID number of the assigned VLAN.
 +
          [network] => The network address of the assigned IP block.
 +
          [cidr] => The CIDR of the assigned IP block.
 +
          [dc] => The datacenter the block of IP addresses belong to (dupont,cimco).
 +
          [vlan_id] => The ID number of the assigned private network VLAN.
 +
          [usable] => An array of all the usable IP addresses that are in the assignment.
 +
        )
 +
      )
 +
      [ip] => The private IP that is assigned the server.
 +
      [cidr] => The CIDR of the assigned IP address.
 +
      [network] => The network address of the assigned IP address.
 +
      [netmask] => The subnet mask of the assigned IP address.
 +
      [gateway] => The gateway address of the assigned IP address.
 +
      [speed] => The speed of the NIC used with the private network.
 +
    )
 +
  )
 +
)
 +
</pre>

Revision as of 23:18, 30 September 2013

IP Justification is used for all requests for additional IPs.

Contents

Path

  • /server/ip/justification/{$serverid}

Method

Availability

Required Data Parameters

  • {$serverid}: The server ID that is returned when using the list command.

Optional Data Parameters

  • None

Returned Data

stdClass Object(
  [success] => TRUE/FALSE
  [data] => stdClass Object(
  [public] => Array(
      [0] => stdClass Object(
        [ip_id] => The ID number of the assigned IP block.
        [prefix] => The network IP address.
        [cidr] => The CIDR of the assigned IP block.
        [parent_id] => 
        [parent_prefix] => 
        [parent_cidr] => 
        [uberid] => 
        [assigned_to] => The ID number of the assigned server.
        [staticrouting] => 
        [last_router] => Hostname of the switch in the server rack.
        [last_vlan] => The VLAN of the "last_router".
        [last_destination] => 
        [filterdev] => 
        [guard_zone] => 
        [hsrp_ip1] => 
        [hsrp_ip2] => 
        [netboot] => 
        [spamscore] => 
        [dc] => The datacenter the block of IP addresses belong to (dupont,cimco).
        [updated] => The last time and date the IP information was updated.
        [gateway] => The gateway IP address of the assigned IP block.
        [ip] => The network IP address of the assigned IP block.
        [netmask] => The subnet mask of the assigned IP block.
        [wildcard] => Wildcard mask of the of the assigned IP block.
        [broadcast] => The broadcast IP address of the assigned IP block.
        [allips] => An array of all the IP addresses that are in the assignment.
        [allusable] => An array of all the usable IP addresses that are in the assignment.
        [firstip] => The first usable IP address that is in the assignment.
        [secondip] => The second usable IP address that is in the assignment.
        [lastip] => The last usable IP address that is in the assignment.
        [range] => The range of usable IP addresses that are in the assignment.
      )
    )
    [private] => stdClass Object(
      [vlan_id] => The ID number of the assigned private network VLAN.
      [dc] => The CIDR of the assigned IP block.
      [vlan] => The number of the assigned VLAN.
      [type] => 
      [uberid] => The assigned client ID.
      [name] => 
      [networks] => Array(
        [0] => stdClass Object(
          [id] => The ID number of the assigned VLAN.
          [network] => The network address of the assigned IP block.
          [cidr] => The CIDR of the assigned IP block.
          [dc] => The datacenter the block of IP addresses belong to (dupont,cimco).
          [vlan_id] => The ID number of the assigned private network VLAN.
          [usable] => An array of all the usable IP addresses that are in the assignment.
        )
      )
      [ip] => The private IP that is assigned the server.
      [cidr] => The CIDR of the assigned IP address.
      [network] => The network address of the assigned IP address.
      [netmask] => The subnet mask of the assigned IP address.
      [gateway] => The gateway address of the assigned IP address.
      [speed] => The speed of the NIC used with the private network.
    )
  )
)
Personal tools