This API v2 is deprecated and may no longer work, or may even be removed soon.
Please refer to our new API v3 documentation for your automation purposes.

User API calls

This page describes all the API calls you can make regarding user administration.
You will always receive the output as described in the documentation below unless an error ocurred. For more information, see the error handling section.

Actions

POST 
getAllAssignedIpRanges

Get all user assigned IP ranges


Request parameters
ParameterContextTypeDescription
No parameters
Response parameters
ParameterContextTypeDescription
rangesarrayYour network ranges.
vlanIdrangesintThe vlan ID
gatewayrangesstringThe gateway IP.
netmaskrangesstringThe range netmask (IPv4 only).
startIprangesstringThe start ip in this range.
firstUsableIprangesstringThe first usable ip in this range.
lastUsableIprangesstringThe last usable ip in this range.
prefixrangesstringCIDR prefix, including leading slash.
locationrangesarrayThe location where this range belongs to.

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [ranges] => Array
                (
                    [0] => Array
                        (
                            [vlanId] => 1184
                            [gateway] => 203.0.113.1
                            [netmask] => 255.255.255.0
                            [startIp] => 203.0.113.3
                            [firstUsableIp] => 203.0.113.3
                            [lastUsableIp] => 203.0.113.254
                            [prefix] => /24
                            [location] => Array
                                (
                                    [LocationId] => 6
                                    [LocationName] => US: Dallas - TX
                                    [DatacenterCode] => usdal1
                                    [LocationShortName] => dfw
                                    [Country] => US
                                    [City] => Dallas
                                    [Address] => Flexential DAL01, 1950 North Stemmons Freeway, Dallas, TX, 75207, United States
                                )

                        )

                    [1] => Array
                        (
                            [vlanId] => 1132
                            [gateway] => 203.0.113.1
                            [netmask] => 255.255.255.0
                            [startIp] => 203.0.113.3
                            [firstUsableIp] => 203.0.113.3
                            [lastUsableIp] => 203.0.113.254
                            [prefix] => /25
                            [location] => Array
                                (
                                    [LocationId] => 3
                                    [LocationName] => EU: Frankfurt
                                    [DatacenterCode] => defra1
                                    [LocationShortName] => fra
                                    [Country] => DE
                                    [City] => Frankfurt
                                    [Address] => Interxion FRA1, Hanauer Landstrasse 298, 60314 Frankfurt am Main, Germany
                                )

                        )

                )

        )

)