Dedicated server API calls

This page describes all the API calls you can make to get information and control your dedicated server(s).
You will always receive the output as described in the documentation below unless an error ocurred. For more information, see the error handling section.

Labels

Label expressions can be used to apply more specific search parameters and can be written in standard SQL query language, remember to urlencode the provided filter query on following actions:

  • getAllIds
  • getAll
  • getFilteredDedi
  • getAllWithGameServers

Using labels in a query

E.g. operating-system="linux" or multiple filters: operating-system="linux" and version=1 or release="alpha".
Remember to urlencode the provided filter query.
E.g. "operating-system%3D%22linux%22" or multiple filters: "operating-system%3D%22linux%22%20and%20version%3D1%20or%20release%3D%22alpha%22"
The final query would look like: /dedicatedserver?labels=operating-system%3D%22linux%22%20and%20version%3D1%20or%20release%3D%22alpha%22

Delete a label

You can delete a label by passing NULL for a label value.
E.g. {"userId": 123456,"apiKey": "Your api key", "dedicatedId": 12345,"action": "setLabels","labels": [{"key": "release","value": null}}]}

Actions

POST 
getAllIds

Get all your dedicated server IDs.


Request parameters
ParameterContextTypeDescription
No parameters
Response parameters
ParameterContextTypeDescription
dedicatedIdsarrayAll your dedicated server IDs.

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [dedicatedIds] => Array
                (
                    [0] => 17455
                    [1] => 17456
                )

        )

)
POST 
getAll

Get a list of all your dedicated servers, including details (but without detailed network and traffic information).


Request parameters
ParameterContextTypeDescription
No parameters
Response parameters
ParameterContextTypeDescription
dedicatedServersarrayList of dedicated servers
serverIddedicatedServersintThe ID of the server
isVirtualdedicatedServersint0: bare metal server, 1: virtual server
dedicatedIddedicatedServersintThe ID of the dedicated server
dediserverNamededicatedServersstringThe name of the server
projectNamededicatedServersstringThe project name of the server (usually the name of a collection of servers)
clientServerNamededicatedServersstringThe name of the server you enter yourself
clientStatededicatedServersstringThe state of the server you enter yourself
BMCtypededicatedServersstringThe BMC port type (0 = shared, 1 = dedicated)
liveHostnamededicatedServersstringLive host name of the physical server
categoryNamededicatedServersstringThe category name for the server
locationIddedicatedServersintLocation ID
locationdedicatedServersstringLocation name
rackIddedicatedServersintRack ID
rackNamededicatedServersstringRack name
statusdedicatedServersstringThe power status of the server
userIddedicatedServersintThe owner userId of the dedicated server
supporttagdedicatedServersstringThe supporttag of the server
i3dServerMonitorVersiondedicatedServersstringi3D.net Server Monitor version string - Only for premium users
i3dServerMonitorCheckVersiondedicatedServersstringi3D.net Server Monitor Check version string - Only for premium users
i3dServerMonitorLastCheckIndedicatedServersstringi3D.net Server Monitor last checkin timestamp - Only for premium users
purchaseOrderdedicatedServersstringPurchase order reference
trafficUseddedicatedServersintUsed traffic in GB
trafficUsedDailyAvededicatedServersintTraffic usage, averaged by day, in GB
trafficTotaldedicatedServersstringTotal committed traffic, in GB
serverCasededicatedServersstringBrand and type of the chassis
numCpudedicatedServersintThe number of CPUs in the chassis
cpuInfodedicatedServersstringCPU information
cpuTypededicatedServersstringCPU type
cpuAlldedicatedServersarrayIndividual CPU information
cpuInfocpuAllstringCPU information
cpuClockSpeedcpuAllintCPU clock speed in MHz
cpuTypecpuAllstringCPU type
memoryInfodedicatedServersarrayInformation for each memory bank
hdInfodedicatedServersarrayInformation about each hard drive
vdInfodedicatedServersarrayInformation about each virtual drive
pciInfodedicatedServersarrayInformation on optional PCI cards (usually RAID card)
dvdInfodedicatedServersstringBrand and type of CD / DVD drive, if any
networkAdapterdedicatedServersstringNetwork adapter brand and type
osIddedicatedServersintOperating System ID (see getOsList)
osNamededicatedServersstringOperating System name
ipdedicatedServersstringThe (first) IP of the server
bmcIpdedicatedServersstringThe KVM IP of the server, if it is assigned one
contractStartdedicatedServersstringThe start date of the contract
contractEnddedicatedServersstringThe end date of the contract
dateCancelleddedicatedServersstringThe date on which the server has been cancelled, if it has been cancelled
monthlyCostdedicatedServersstringCost per month
statusdedicatedServersstringThe BMC (management) status (Online / Offline / BMC Not Installed / BMC Failed)
uptimededicatedServersinUptime in seconds
cpuLoaddedicatedServersintCPU load
memMaxdedicatedServersintMaximum available memory
hddSpacededicatedServersintTotal available drive space
labelsdedicatedServersarrayCustom key/value pairs that can be used for filtering dedicated servers.

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [dedicatedServers] => Array
                (
                    [0] => Array
                        (
                            [serverId] => 24560
                            [isVirtual] => 0
                            [dedicatedId] => 17455
                            [dediserverName] => Server 3523
                            [projectName] => Example project name
                            [clientServerName] => Example server name
                            [clientState] => Provisioning
                            [BMCtype] => 1
                            [liveHostname] => Live name
                            [categoryName] => Dedicated Servers
                            [locationId] => 18
                            [location] => EU: Rotterdam
                            [rackId] => 331
                            [rackName] => Suite 24 - Rack 01
                            [status] => Online
                            [userId] => 113311
                            [supporttag] => GB8039759R
                            [purchaseOrder] => ORDER-1
                            [trafficUsed] => 0
                            [trafficUsedDailyAve] => 0
                            [trafficTotal] => 1000 Unm. Mb
                            [serverCase] => HP - ProLiant DL120 G6
                            [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                            [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                            [cpuAll] => Array
                                (
                                    [0] => Array
                                        (
                                            [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                                            [cpuClockSpeed] => 2400
                                            [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                                        )

                                    [1] => Array
                                        (
                                            [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                                            [cpuClockSpeed] => 2400
                                            [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                                        )

                                )

                            [memoryInfo] => Array
                                (
                                    [0] => Array
                                        (
                                            [memorySlot] => DIMM A1
                                            [brand] => Hynix Semiconductor (Hyundai Electronics)
                                            [model] => HMT325U7BFR8A-H9
                                            [size] => 2GiB
                                            [speed] => 1333
                                            [memoryType] => DIMM DDR3
                                        )

                                )

                            [hdInfo] => Array
                                (
                                    [0] => Array
                                        (
                                            [diskType] => ATA Disk
                                            [product] => WDC WD2502ABYS-1
                                            [firmwareVersion] => 3B05
                                            [size] => 1000
                                        )

                                )

                            [vdInfo] => Array
                                (
                                    [0] => Array
                                        (
                                            [diskType] => ATA Disk
                                            [product] => WDC WD2502ABYS-1
                                            [firmwareVersion] => 3B05
                                            [size] => 1000
                                        )

                                )

                            [pciInfo] => Array
                                (
                                )

                            [dvdInfo] => 
                            [networkAdapter] => 01:00.0 Intel Corporation 82599EB 10-Gigabit SFI/SFP  Network Connection (rev 01) [   30.642704] tg3 Link is up at 1000 Mbps full duplex
                            [osId] => 85
                            [osName] => CentOS 6.5
                            [ip] => 31.204.128.183
                            [contractStart] => 30 Aug 2013
                            [contractEnd] => 01 Oct 2019
                            [dateCancelled] => 
                            [monthlyCost] => 60 Euro
                            [uptime] => 0
                            [cpuLoad] => 1
                            [memFree] => 7864
                            [memMax] => 0
                            [hddSpace] => 2000000
                            [hddFree] => 93140
                            [labels] => Array
                                (
                                    [0] => Array
                                        (
                                            [key] => operating-system
                                            [value] => linux
                                        )

                                    [1] => Array
                                        (
                                            [key] => project
                                            [value] => project name
                                        )

                                )

                        )

                )

        )

)
POST 
getDediById

Get detailed information of a single dedicated server, including network and traffic details.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
trafficDaysint(optional) returns daily traffic usage if larger than 0 (max. 30)
PLEASE NOTE: you are limited to 12 traffic requests per minute.
Response parameters
ParameterContextTypeDescription
dedicatedServersarrayList of dedicated servers
serverIddedicatedServersintThe ID of the server
isVirtualdedicatedServersint0: bare metal server, 1: virtual server
dedicatedIddedicatedServersintThe ID of the dedicated server
dediserverNamededicatedServersstringThe name of the server
clientStatededicatedServersstringThe state of the server you enter yourself
projectNamededicatedServersstringThe project name of the server (usually the name of a collection of servers)
clientServerNamededicatedServersstringThe name of the server you enter yourself
BMCtypededicatedServersstringThe BMC port type (0 = shared, 1 = dedicated)
liveHostnamededicatedServersstringLive host name of the physical server
categoryNamededicatedServersstringThe category name for the server
locationIddedicatedServersintLocation ID
locationdedicatedServersstringLocation name
rackIddedicatedServersintRack ID
rackNamededicatedServersstringRack name
statusdedicatedServersstringThe power status of the server
userIddedicatedServersintThe owner userId of the dedicated server
supporttagdedicatedServersstringThe supporttag of the server
i3dServerMonitorVersiondedicatedServersstringi3D.net Server Monitor version string - Only for premium users
i3dServerMonitorCheckVersiondedicatedServersstringi3D.net Server Monitor Check version string - Only for premium users
i3dServerMonitorLastCheckIndedicatedServersstringi3D.net Server Monitor last checkin timestamp - Only for premium users
purchaseOrderdedicatedServersstringPurchase order reference
trafficUseddedicatedServersintUsed traffic in GB
trafficUsedDailyAvededicatedServersintTraffic usage, averaged by day, in GB
trafficTotaldedicatedServersstringTotal committed traffic, in GB
serverCasededicatedServersstringBrand and type of the chassis
cpuInfodedicatedServersstringCPU information
cpuTypededicatedServersstringCPU type
cpuAlldedicatedServersarrayIndividual CPU information
cpuInfocpuAllstringCPU information
cpuClockSpeedcpuAllintCPU clock speed in MHz
cpuTypecpuAllstringCPU type
memoryInfodedicatedServersarrayInformation for each memory bank
hdInfodedicatedServersarrayInformation about each hard drive
vdInfodedicatedServersarrayInformation about each virtual drive
pciInfodedicatedServersarrayInformation on optional PCI cards (usually RAID card)
dvdInfodedicatedServersstringBrand and type of CD / DVD drive, if any
networkAdapterdedicatedServersstringNetwork adapter brand and type
osIddedicatedServersstringOperating System ID (see getOsList)
osNamededicatedServersstringOperating System name
ipdedicatedServersstringThe (first) IP of the server
bmcIpdedicatedServersstringThe KVM IP of the server, if it is assigned one
contractStartdedicatedServersstringThe start date of the contract
contractEnddedicatedServersstringThe end date of the contract
dateCancelleddedicatedServersstringThe date on which the server has been cancelled, if it has been cancelled
monthlyCostdedicatedServersstringCost per month
statusdedicatedServersstringThe BMC (management) status (Online / Offline / BMC Not Installed / BMC Failed)
uptimededicatedServersinUptime in seconds
cpuLoaddedicatedServersintCPU load
memFreededicatedServersintFree memory in MB
memMaxdedicatedServersintMaximum available memory
hddSpacededicatedServersintTotal available drive space
hddFreededicatedServersintRemaining free drive space
trafficDetailsdedicatedServersarrayArray of network links and their daily traffic stats.
linkNametrafficDetailsstringName of the link - container for traffic history
datelinkNamestringTraffic date
inlinkNamefloatIncoming traffic
outlinkNamefloatOutgoing traffic

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [dedicatedServer] => Array
                (
                    [serverId] => 24560
                    [isVirtual] => 0
                    [dedicatedId] => 17455
                    [dediserverName] => Server 3523
                    [projectName] => Example project name
                    [clientServerName] => Example server name
                    [clientState] => Provisioning
                    [BMCtype] => 1
                    [liveHostname] => Live name
                    [categoryName] => Dedicated Servers
                    [locationId] => 18
                    [location] => EU: Rotterdam
                    [rackId] => 331
                    [rackName] => Suite 24 - Rack 01
                    [status] => Online
                    [userId] => 113311
                    [supporttag] => GB8039759R
                    [purchaseOrder] => ORDER-1
                    [trafficUsed] => 0
                    [trafficUsedDailyAve] => 0
                    [trafficTotal] => 1000 Unm. Mb
                    [serverCase] => HP - ProLiant DL120 G6
                    [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                    [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                    [cpuAll] => Array
                        (
                            [0] => Array
                                (
                                    [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                                    [cpuClockSpeed] => 2400
                                    [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                                )

                            [1] => Array
                                (
                                    [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                                    [cpuClockSpeed] => 2400
                                    [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                                )

                        )

                    [memoryInfo] => Array
                        (
                            [0] => Array
                                (
                                    [memorySlot] => DIMM A1
                                    [brand] => Hynix Semiconductor (Hyundai Electronics)
                                    [model] => HMT325U7BFR8A-H9
                                    [size] => 2GiB
                                    [speed] => 1333
                                    [memoryType] => DIMM DDR3
                                )

                        )

                    [hdInfo] => Array
                        (
                            [0] => Array
                                (
                                    [diskType] => ATA Disk
                                    [product] => WDC WD2502ABYS-1
                                    [firmwareVersion] => 3B05
                                    [size] => 1000
                                )

                        )

                    [vdInfo] => Array
                        (
                            [0] => Array
                                (
                                    [diskType] => ATA Disk
                                    [product] => WDC WD2502ABYS-1
                                    [firmwareVersion] => 3B05
                                    [size] => 1000
                                )

                        )

                    [pciInfo] => Array
                        (
                        )

                    [dvdInfo] => 
                    [networkAdapter] => 01:00.0 Intel Corporation 82599EB 10-Gigabit SFI/SFP  Network Connection (rev 01) [   30.642704] tg3 Link is up at 1000 Mbps full duplex
                    [osId] => 85
                    [osName] => CentOS 6.5
                    [ip] => 31.204.128.183
                    [contractStart] => 30 Aug 2013
                    [contractEnd] => 01 Oct 2019
                    [dateCancelled] => 
                    [monthlyCost] => 60 Euro
                    [uptime] => 0
                    [cpuLoad] => 1
                    [memFree] => 7864
                    [memMax] => 0
                    [hddSpace] => 2000000
                    [hddFree] => 93140
                    [labels] => Array
                        (
                            [0] => Array
                                (
                                    [key] => operating-system
                                    [value] => linux
                                )

                            [1] => Array
                                (
                                    [key] => project
                                    [value] => project name
                                )

                        )

                    [trafficDetails] => Array
                        (
                            [link0] => Array
                                (
                                    [0] => Array
                                        (
                                            [date] => 2014-06-30
                                            [in] => 0.01
                                            [out] => 0.09
                                        )

                                )

                            [link1] => Array
                                (
                                    [0] => Array
                                        (
                                            [date] => 2014-06-30
                                            [in] => 0
                                            [out] => 0.59
                                        )

                                )

                        )

                )

        )

)
POST 
getFilteredDedi

Filter dedicated servers by ip, serverId, servername, dedicatedId or supporttag


Request parameters
ParameterContextTypeDescription
filtersarrayArray of search values. example: ["servername" => "Server 10295", "ip" => "5.200.5.200", "serverId" => "12345", "dedicatedId" => "12345", "supporttag" => "173P35J"]
Response parameters
ParameterContextTypeDescription
dedicatedServersarrayList of dedicated servers
serverIddedicatedServersintThe ID of the server
isVirtualdedicatedServersint0: bare metal server, 1: virtual server
dedicatedIddedicatedServersintThe ID of the dedicated server
dediserverNamededicatedServersstringThe name of the server
clientStatededicatedServersstringThe state of the server you enter yourself
projectNamededicatedServersstringThe project name of the server (usually the name of a collection of servers)
clientServerNamededicatedServersstringThe name of the server you enter yourself
BMCtypededicatedServersstringThe BMC port type (0 = shared, 1 = dedicated)
liveHostnamededicatedServersstringLive host name of the physical server
categoryNamededicatedServersstringThe category name for the server
locationIddedicatedServersintLocation ID
locationdedicatedServersstringLocation name
rackIddedicatedServersintRack ID
rackNamededicatedServersstringRack name
statusdedicatedServersstringThe power status of the server
userIddedicatedServersintThe owner userId of the dedicated server
supporttagdedicatedServersstringThe supporttag of the server
i3dServerMonitorVersiondedicatedServersstringi3D.net Server Monitor version string - Only for premium users
i3dServerMonitorCheckVersiondedicatedServersstringi3D.net Server Monitor Check version string - Only for premium users
i3dServerMonitorLastCheckIndedicatedServersstringi3D.net Server Monitor last checkin timestamp - Only for premium users
purchaseOrderdedicatedServersstringPurchase order reference
trafficUseddedicatedServersintUsed traffic in GB
trafficUsedDailyAvededicatedServersintTraffic usage, averaged by day, in GB
trafficTotaldedicatedServersstringTotal committed traffic, in GB
serverCasededicatedServersstringBrand and type of the chassis
cpuInfodedicatedServersstringCPU information
cpuTypededicatedServersstringCPU type
cpuAlldedicatedServersarrayIndividual CPU information
cpuInfocpuAllstringCPU information
cpuClockSpeedcpuAllintCPU clock speed in MHz
cpuTypecpuAllstringCPU type
memoryInfodedicatedServersarrayInformation for each memory bank
hdInfodedicatedServersarrayInformation about each hard drive
vdInfodedicatedServersarrayInformation about each virtual drive
pciInfodedicatedServersarrayInformation on optional PCI cards (usually RAID card)
dvdInfodedicatedServersstringBrand and type of CD / DVD drive, if any
networkAdapterdedicatedServersstringNetwork adapter brand and type
osIddedicatedServersstringOperating System ID (see getOsList)
osNamededicatedServersstringOperating System name
ipdedicatedServersstringThe (first) IP of the server
bmcIpdedicatedServersstringThe KVM IP of the server, if it is assigned one
contractStartdedicatedServersstringThe start date of the contract
contractEnddedicatedServersstringThe end date of the contract
dateCancelleddedicatedServersstringThe date on which the server has been cancelled, if it has been cancelled
monthlyCostdedicatedServersstringCost per month
statusdedicatedServersstringThe BMC (management) status (Online / Offline / BMC Not Installed / BMC Failed)
uptimededicatedServersinUptime in seconds
cpuLoaddedicatedServersintCPU load
memFreededicatedServersintFree memory in MB
memMaxdedicatedServersintMaximum available memory
hddSpacededicatedServersintTotal available drive space
hddFreededicatedServersintRemaining free drive space
labelsdedicatedServersarrayCustom key/value pairs that can be used for filtering dedicated servers.

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [dedicatedServer] => Array
                (
                    [serverId] => 24560
                    [isVirtual] => 0
                    [dedicatedId] => 17455
                    [dediserverName] => Server 3523
                    [projectName] => Example project name
                    [clientServerName] => Example server name
                    [clientState] => Provisioning
                    [BMCtype] => 1
                    [liveHostname] => Live name
                    [categoryName] => Dedicated Servers
                    [locationId] => 18
                    [location] => EU: Rotterdam
                    [rackId] => 331
                    [rackName] => Suite 24 - Rack 01
                    [status] => Online
                    [userId] => 113311
                    [supporttag] => GB8039759R
                    [purchaseOrder] => ORDER-1
                    [trafficUsed] => 0
                    [trafficUsedDailyAve] => 0
                    [trafficTotal] => 1000 Unm. Mb
                    [serverCase] => HP - ProLiant DL120 G6
                    [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                    [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                    [cpuAll] => Array
                        (
                            [0] => Array
                                (
                                    [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                                    [cpuClockSpeed] => 2400
                                    [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                                )

                            [1] => Array
                                (
                                    [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                                    [cpuClockSpeed] => 2400
                                    [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                                )

                        )

                    [memoryInfo] => Array
                        (
                            [0] => Array
                                (
                                    [memorySlot] => DIMM A1
                                    [brand] => Hynix Semiconductor (Hyundai Electronics)
                                    [model] => HMT325U7BFR8A-H9
                                    [size] => 2GiB
                                    [speed] => 1333
                                    [memoryType] => DIMM DDR3
                                )

                        )

                    [hdInfo] => Array
                        (
                            [0] => Array
                                (
                                    [diskType] => ATA Disk
                                    [product] => WDC WD2502ABYS-1
                                    [firmwareVersion] => 3B05
                                    [size] => 1000
                                )

                        )

                    [vdInfo] => Array
                        (
                            [0] => Array
                                (
                                    [diskType] => ATA Disk
                                    [product] => WDC WD2502ABYS-1
                                    [firmwareVersion] => 3B05
                                    [size] => 1000
                                )

                        )

                    [pciInfo] => Array
                        (
                        )

                    [dvdInfo] => 
                    [networkAdapter] => 01:00.0 Intel Corporation 82599EB 10-Gigabit SFI/SFP  Network Connection (rev 01) [   30.642704] tg3 Link is up at 1000 Mbps full duplex
                    [osId] => 85
                    [osName] => CentOS 6.5
                    [ip] => 31.204.128.183
                    [contractStart] => 30 Aug 2013
                    [contractEnd] => 01 Oct 2019
                    [dateCancelled] => 
                    [monthlyCost] => 60 Euro
                    [uptime] => 0
                    [cpuLoad] => 1
                    [memFree] => 7864
                    [memMax] => 0
                    [hddSpace] => 2000000
                    [hddFree] => 93140
                    [labels] => Array
                        (
                            [0] => Array
                                (
                                    [key] => operating-system
                                    [value] => linux
                                )

                            [1] => Array
                                (
                                    [key] => project
                                    [value] => project name
                                )

                        )

                )

        )

)
POST 
getAllWithGameServers

Get detailed information of all dedicated servers with game servers running on them. Includes counters for game server running on them.


Request parameters
ParameterContextTypeDescription
incGameServerDetailsintAlso include all details of the game instances on the dedicated server (0 or 1).
Response parameters
ParameterContextTypeDescription
dedicatedServersarrayList of dedicated servers
serverIddedicatedServersintThe ID of the server
isVirtualdedicatedServersint0: bare metal server, 1: virtual server
dedicatedIddedicatedServersintThe ID of the dedicated server
dediserverNamededicatedServersstringThe name of the server
projectNamededicatedServersstringThe project name of the server (usually the name of a collection of servers)
clientServerNamededicatedServersstringThe name of the server you enter yourself
clientStatededicatedServersstringThe state of the server you enter yourself
BMCtypededicatedServersstringThe BMC port type (0 = shared, 1 = dedicated)
liveHostnamededicatedServersstringLive host name of the physical server
categoryNamededicatedServersstringThe category name for the server
locationIddedicatedServersintLocation ID
locationdedicatedServersstringLocation name
rackIddedicatedServersintRack ID
rackNamededicatedServersstringRack name
statusdedicatedServersstringThe power status of the server
userIddedicatedServersintThe owner userId of the dedicated server
supporttagdedicatedServersstringThe supporttag of the server
i3dServerMonitorVersionserversstringi3D.net Server Monitor version string - Only for premium users
i3dServerMonitorCheckVersionserversstringi3D.net Server Monitor Check version string - Only for premium users
i3dServerMonitorLastCheckInserversstringi3D.net Server Monitor last checkin timestamp - Only for premium users
purchaseOrderserversstringPurchase order reference
trafficUseddedicatedServersintUsed traffic in GB
trafficUsedDailyAvededicatedServersintTraffic usage, averaged by day, in GB
trafficTotaldedicatedServersstringTotal committed traffic, in GB
serverCasededicatedServersstringBrand and type of the chassis
cpuInfodedicatedServersstringCPU information
cpuTypededicatedServersstringCPU type
cpuAlldedicatedServersarrayIndividual CPU information
cpuInfocpuAllstringCPU information
cpuClockSpeedcpuAllintCPU clock speed in MHz
cpuTypecpuAllstringCPU type
memoryInfodedicatedServersarrayInformation for each memory bank
vdInfodedicatedServersarrayInformation about each hard drive
pciInfodedicatedServersarrayInformation on optional PCI cards (usually RAID card)
dvdInfodedicatedServersstringBrand and type of CD / DVD drive, if any
networkAdapterdedicatedServersstringNetwork adapter brand and type
osIddedicatedServersstringOperating System ID (see getOsList)
osNamededicatedServersstringOperating System name
ipdedicatedServersstringThe (first) IP of the server
bmcIpdedicatedServersstringThe KVM IP of the server, if it is assigned one
contractStartdedicatedServersstringThe start date of the contract
contractEnddedicatedServersstringThe end date of the contract
dateCancelleddedicatedServersstringThe date on which the server has been cancelled, if it has been cancelled
monthlyCostdedicatedServersstringCost per month
statusdedicatedServersstringThe BMC (management) status (Online / Offline / BMC Not Installed / BMC Failed)
uptimededicatedServersinUptime in seconds
cpuLoaddedicatedServersintCPU load
memFreededicatedServersintFree memory in MB
memMaxdedicatedServersintMaximum available memory
hddSpacededicatedServersintTotal available drive space
hddFreededicatedServersintRemaining free drive space
gameserverStatsdedicatedServersarrayList of simple game stats / counters per dedicated server, per game
<GAMEID>gameserverStatsintGame stats per game ID
numGameserversOnline<GAMEID>intNumber of online game servers
numGameserversOffline<GAMEID>intNumber of offline game servers
numLivePlayers<GAMEID>intNumber of players currently on the servers.
gameserverDetailsdedicatedServersarrayFull details of all game instances hosted on the servers (if incGameServerDetails = 1)
labelsdedicatedServersarrayCustom key/value pairs that can be used for filtering dedicated servers.

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [dedicatedServers] => Array
                (
                    [0] => Array
                        (
                            [serverId] => 24560
                            [isVirtual] => 0
                            [dedicatedId] => 17455
                            [dediserverName] => Server 3523
                            [projectName] => Example project name
                            [clientServerName] => Example server name
                            [clientState] => Provisioning
                            [BMCtype] => 1
                            [liveHostname] => Live name
                            [categoryName] => Dedicated Servers
                            [locationId] => 18
                            [location] => EU: Rotterdam
                            [rackId] => 331
                            [rackName] => Suite 24 - Rack 01
                            [status] => Online
                            [userId] => 113311
                            [supporttag] => GB8039759R
                            [purchaseOrder] => ORDER-1
                            [trafficUsed] => 0
                            [trafficUsedDailyAve] => 0
                            [trafficTotal] => 1000 Unm. Mb
                            [serverCase] => HP - ProLiant DL120 G6
                            [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                            [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                            [cpuAll] => Array
                                (
                                    [0] => Array
                                        (
                                            [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                                            [cpuClockSpeed] => 2400
                                            [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                                        )

                                    [1] => Array
                                        (
                                            [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                                            [cpuClockSpeed] => 2400
                                            [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                                        )

                                )

                            [memoryInfo] => Array
                                (
                                    [0] => Array
                                        (
                                            [memorySlot] => DIMM A1
                                            [brand] => Hynix Semiconductor (Hyundai Electronics)
                                            [model] => HMT325U7BFR8A-H9
                                            [size] => 2GiB
                                            [speed] => 1333
                                            [memoryType] => DIMM DDR3
                                        )

                                )

                            [hdInfo] => Array
                                (
                                    [0] => Array
                                        (
                                            [diskType] => ATA Disk
                                            [product] => WDC WD2502ABYS-1
                                            [firmwareVersion] => 3B05
                                            [size] => 1000
                                        )

                                )

                            [vdInfo] => Array
                                (
                                    [0] => Array
                                        (
                                            [diskType] => ATA Disk
                                            [product] => WDC WD2502ABYS-1
                                            [firmwareVersion] => 3B05
                                            [size] => 1000
                                        )

                                )

                            [pciInfo] => Array
                                (
                                )

                            [dvdInfo] => 
                            [networkAdapter] => 01:00.0 Intel Corporation 82599EB 10-Gigabit SFI/SFP  Network Connection (rev 01) [   30.642704] tg3 Link is up at 1000 Mbps full duplex
                            [osId] => 85
                            [osName] => CentOS 6.5
                            [ip] => 31.204.128.183
                            [contractStart] => 30 Aug 2013
                            [contractEnd] => 01 Oct 2019
                            [dateCancelled] => 
                            [monthlyCost] => 60 Euro
                            [uptime] => 0
                            [cpuLoad] => 1
                            [memFree] => 7864
                            [memMax] => 0
                            [hddSpace] => 2000000
                            [hddFree] => 93140
                            [gameserverStats] => Array
                                (
                                    [numGameserversOnline] => 0
                                    [numGameserversOffline] => 0
                                    [numLivePlayers] => 0
                                )

                            [gameserverDetails] => Array
                                (
                                    [0] => All game server details as if retrieved via the game server category
                                )

                            [labels] => Array
                                (
                                    [0] => Array
                                        (
                                            [key] => platform
                                            [value] => platform name
                                        )

                                    [1] => Array
                                        (
                                            [key] => project
                                            [value] => project name
                                        )

                                )

                        )

                )

        )

)
POST 
getDetails

Get your project name, own server name and state.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
Response parameters
ParameterContextTypeDescription
setDetailsarrayList of details you provided
projectNamesetDetailsstringThe project name as you entered it
clientServerNamesetDetailsstringThe client server name as you entered it
clientStatesetDetailsstringThe client state as you entered it

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [setDetails] => Array
                (
                    [projectName] => Website cluster
                    [clientServerName] => Web 1
                    [clientState] => Provisioning
                )

        )

)
POST 
setDetails

Set your project name, own server name and state.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
projectNamestringYour project name (often a name to identify a collection of servers) (max 100 chars)
clientServerNamestringYour own name for a dedicated server
clientStatestringYour defined state for a dedicated server
Response parameters
ParameterContextTypeDescription
setDetailsarrayList of details you provided
projectNamesetDetailsstringThe project name as you entered it
clientServerNamesetDetailsstringThe client server name as you entered it
clientStatesetDetailsstringThe client state as you entered it

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [setDetails] => Array
                (
                    [projectName] => Website cluster
                    [clientServerName] => Web 1
                    [clientState] => Provisioning
                )

        )

)
POST 
setLabels

Add custom key/value pairs with dedicated server.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
labelsarrayCustom key/value pairs that can be used for filtering dedicated servers.
E.g.
"labels": [
                {
                "key": "labelkey",
                "value": "label value"
                }
             ]
Response parameters
ParameterContextTypeDescription
dedicatedServersarrayList of dedicated servers
serverIddedicatedServersintThe ID of the server
isVirtualdedicatedServersint0: bare metal server, 1: virtual server
dedicatedIddedicatedServersintThe ID of the dedicated server
dediserverNamededicatedServersstringThe name of the server
projectNamededicatedServersstringThe project name of the server (usually the name of a collection of servers)
clientServerNamededicatedServersstringThe name of the server you enter yourself
clientStatededicatedServersstringThe state of the server you enter yourself
BMCtypededicatedServersstringThe BMC port type (0 = shared, 1 = dedicated)
liveHostnamededicatedServersstringLive host name of the physical server
categoryNamededicatedServersstringThe category name for the server
locationIddedicatedServersintLocation ID
locationdedicatedServersstringLocation name
rackIddedicatedServersintRack ID
rackNamededicatedServersstringRack name
statusdedicatedServersstringThe power status of the server
userIddedicatedServersintThe owner userId of the dedicated server
supporttagdedicatedServersstringThe supporttag of the server
i3dServerMonitorVersiondedicatedServersstringi3D.net Server Monitor version string - Only for premium users
i3dServerMonitorCheckVersiondedicatedServersstringi3D.net Server Monitor Check version string - Only for premium users
i3dServerMonitorLastCheckIndedicatedServersstringi3D.net Server Monitor last checkin timestamp - Only for premium users
purchaseOrderdedicatedServersstringPurchase order reference
trafficUseddedicatedServersintUsed traffic in GB
trafficUsedDailyAvededicatedServersintTraffic usage, averaged by day, in GB
trafficTotaldedicatedServersstringTotal committed traffic, in GB
serverCasededicatedServersstringBrand and type of the chassis
numCpudedicatedServersintThe number of CPUs in the chassis
cpuInfodedicatedServersstringCPU information
cpuTypededicatedServersstringCPU type
cpuAlldedicatedServersarrayIndividual CPU information
cpuInfocpuAllstringCPU information
cpuClockSpeedcpuAllintCPU clock speed in MHz
cpuTypecpuAllstringCPU type
memoryInfodedicatedServersarrayInformation for each memory bank
hdInfodedicatedServersarrayInformation about each hard drive
vdInfodedicatedServersarrayInformation about each virtual drive
pciInfodedicatedServersarrayInformation on optional PCI cards (usually RAID card)
dvdInfodedicatedServersstringBrand and type of CD / DVD drive, if any
networkAdapterdedicatedServersstringNetwork adapter brand and type
osIddedicatedServersintOperating System ID (see getOsList)
osNamededicatedServersstringOperating System name
ipdedicatedServersstringThe (first) IP of the server
bmcIpdedicatedServersstringThe KVM IP of the server, if it is assigned one
contractStartdedicatedServersstringThe start date of the contract
contractEnddedicatedServersstringThe end date of the contract
dateCancelleddedicatedServersstringThe date on which the server has been cancelled, if it has been cancelled
monthlyCostdedicatedServersstringCost per month
statusdedicatedServersstringThe BMC (management) status (Online / Offline / BMC Not Installed / BMC Failed)
uptimededicatedServersinUptime in seconds
cpuLoaddedicatedServersintCPU load
memMaxdedicatedServersintMaximum available memory
hddSpacededicatedServersintTotal available drive space
labelsdedicatedServersarrayCustom key/value pairs that can be used for filtering dedicated servers.

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [dedicatedServers] => Array
                (
                    [0] => Array
                        (
                            [serverId] => 24560
                            [isVirtual] => 0
                            [dedicatedId] => 17455
                            [dediserverName] => Server 3523
                            [projectName] => Example project name
                            [clientServerName] => Example server name
                            [clientState] => Provisioning
                            [BMCtype] => 1
                            [liveHostname] => Live name
                            [categoryName] => Dedicated Servers
                            [locationId] => 18
                            [location] => EU: Rotterdam
                            [rackId] => 331
                            [rackName] => Suite 24 - Rack 01
                            [status] => Online
                            [userId] => 113311
                            [supporttag] => GB8039759R
                            [purchaseOrder] => ORDER-1
                            [trafficUsed] => 0
                            [trafficUsedDailyAve] => 0
                            [trafficTotal] => 1000 Unm. Mb
                            [serverCase] => HP - ProLiant DL120 G6
                            [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                            [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                            [cpuAll] => Array
                                (
                                    [0] => Array
                                        (
                                            [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                                            [cpuClockSpeed] => 2400
                                            [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                                        )

                                    [1] => Array
                                        (
                                            [cpuInfo] => CPU Family: Type 0, Family 6, Model 30, Stepping 5L2 Cache: 8192 KBFront Side Bus: 133 MHz
                                            [cpuClockSpeed] => 2400
                                            [cpuType] => Intel(R) Xeon(R) CPU X3430 @ 2.40GHz
                                        )

                                )

                            [memoryInfo] => Array
                                (
                                    [0] => Array
                                        (
                                            [memorySlot] => DIMM A1
                                            [brand] => Hynix Semiconductor (Hyundai Electronics)
                                            [model] => HMT325U7BFR8A-H9
                                            [size] => 2GiB
                                            [speed] => 1333
                                            [memoryType] => DIMM DDR3
                                        )

                                )

                            [hdInfo] => Array
                                (
                                    [0] => Array
                                        (
                                            [diskType] => ATA Disk
                                            [product] => WDC WD2502ABYS-1
                                            [firmwareVersion] => 3B05
                                            [size] => 1000
                                        )

                                )

                            [vdInfo] => Array
                                (
                                    [0] => Array
                                        (
                                            [diskType] => ATA Disk
                                            [product] => WDC WD2502ABYS-1
                                            [firmwareVersion] => 3B05
                                            [size] => 1000
                                        )

                                )

                            [pciInfo] => Array
                                (
                                )

                            [dvdInfo] => 
                            [networkAdapter] => 01:00.0 Intel Corporation 82599EB 10-Gigabit SFI/SFP  Network Connection (rev 01) [   30.642704] tg3 Link is up at 1000 Mbps full duplex
                            [osId] => 85
                            [osName] => CentOS 6.5
                            [ip] => 31.204.128.183
                            [contractStart] => 30 Aug 2013
                            [contractEnd] => 01 Oct 2019
                            [dateCancelled] => 
                            [monthlyCost] => 60 Euro
                            [uptime] => 0
                            [cpuLoad] => 1
                            [memFree] => 7864
                            [memMax] => 0
                            [hddSpace] => 2000000
                            [hddFree] => 93140
                            [labels] => Array
                                (
                                    [0] => Array
                                        (
                                            [key] => platform
                                            [value] => platform name
                                        )

                                    [1] => Array
                                        (
                                            [key] => project
                                            [value] => project name
                                        )

                                )

                        )

                )

        )

)

Networking

POST 
getTraffic

Get traffic data for the past 3 months, for every network link. Will include graph image data if incGraph is 1.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
incGraphint(optional) Include graph image data if 1.
PLEASE NOTE: you are limited to 12 traffic requests per minute.
dateStartstringThe start date of fetched traffic in format: DD-MM-YYYY (optional)
dateEndstringThe end date of fetched traffic in format: DD-MM-YYYY (optional)
Response parameters
ParameterContextTypeDescription
trafficarrayList of network interfaces and their traffic.
linkNametrafficarrayTraffic data per day, for 3 months.
datelinkNamestringThe date of the day holding the stats.
inlinkNamefloatIncoming traffic for that day.
outlinkNamefloatOutgoing traffic for that day.

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [traffic] => Array
                (
                    [link0] => Array
                        (
                            [0] => Array
                                (
                                    [date] => 2014-06-30
                                    [in] => 0.01
                                    [out] => 0.09
                                )

                            [1] => Array
                                (
                                    [date] => 2014-06-29
                                    [in] => 0.06
                                    [out] => 0.13
                                )

                            [2] => Array
                                (
                                    [date] => 2014-06-28
                                    [in] => 0.12
                                    [out] => 0.68
                                )

                            [3] => Array
                                (
                                    [date] => 2014-06-27
                                    [in] => 0.12
                                    [out] => 0.29
                                )

                            [4] => Array
                                (
                                    [etc] => ...
                                )

                            [graphDay] => base64encoded image data (png)
                            [graphWeek] => base64encoded image data (png)
                            [graphMonth] => base64encoded image data (png)
                            [graphYear] => base64encoded image data (png)
                        )

                )

        )

)
POST 
getTrafficGraphs

Get traffic graphs (24 hours, week, month and year), for every network link.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server.
PLEASE NOTE: you are limited to 12 traffic requests per minute.
dateStartstringThe start date of fetched traffic in format: DD-MM-YYYY (optional)
dateEndstringThe end date of fetched traffic in format: DD-MM-YYYY (optional)
Response parameters
ParameterContextTypeDescription
traffic
linkXtrafficThe link for which the graphs are presented.
graphDaylinkXbase64encodedTraffic graph of the last 24 hours.
graphWeeklinkXbase64encodedTraffic graph of the last week.
graphMonthlinkXbase64encodedTraffic graph of the last month.
graphYearlinkXbase64encodedTraffic graph of the last year.

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [traffic] => Array
                (
                    [link0] => Array
                        (
                            [graphDay] => base64encoded image data (image/png)
                            [graphWeek] => base64encoded image data (image/png)
                            [graphMonth] => base64encoded image data (image/png)
                            [graphYear] => base64encoded image data (image/png)
                        )

                )

        )

)
POST 
getTrafficAlerts

Get the traffic alerts set for your dedicated server.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
Response parameters
ParameterContextTypeDescription
alertsarrayAlerts array
idalertsintThe ID of the alert
percentagealertsintThe percentage at which the alert will be triggered
emailOnAlertalertsint0 - 1, whether to receive an email on alert
ticketOnAlertalertsint0 - 1, whether to receive a ticket on alert

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [alerts] => Array
                (
                    [0] => Array
                        (
                            [id] => 155
                            [percentage] => 90
                            [emailOnAlert] => 1
                            [ticketOnAlert] => 0
                        )

                    [1] => Array
                        (
                            [id] => 165
                            [percentage] => 10
                            [emailOnAlert] => 1
                            [ticketOnAlert] => 0
                        )

                    [2] => Array
                        (
                            [id] => 166
                            [percentage] => 20
                            [emailOnAlert] => 1
                            [ticketOnAlert] => 0
                        )

                )

        )

)
POST 
setTrafficAlerts

Set the traffic alerts set for your dedicated server.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
alertsarray
idalertsintThe ID of the alert
percentagealertsintThe percentage at which the alert will be triggered
emailOnAlertalertsint0 - 1, whether to receive an email on alert (if this is set, you cannot set ticketOnAlert)
ticketOnAlertalertsint0 - 1, whether to receive a ticket on alert (if this is set, you cannot set emailOnAlert)
removealertsint(optional) if 1, remove this entry
Response parameters
ParameterContextTypeDescription
updatesarrayArray of update results
resultupdatesstringOK or Error
msgupdatesstringIf there is an error, this is the error message

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [updates] => Array
                (
                    [0] => Array
                        (
                            [result] => OK
                            [msg] => Alert with ID 155 has been updated.
                        )

                )

        )

)
POST 
getNetworkDetails

Get all network details for your dedicated server.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
Response parameters
ParameterContextTypeDescription
interfacesarrayArray of network details for every interface
vlansinterfacesarrayContains vlan network information
vlanIdvlansintThe vlan ID
gatewayvlansstringGateway IP
netmaskvlansstringIPv4 netmask (not present for IPv6)
typevlansstringDefines vlan IP version either IPv4 or IPv6
prefixvlansstringCIDR prefix, includes leading slash (/)
ipv4interfacesarrayContains IPv4 network information
ipv6interfacesarrayContains IPv6 network information
ipsipv4/ipv6arrayIP information
ipipsstringAn IP address
ipTypeipsstringIP type (kvm / normal)
vlanIdipsintThe vlan ID
ptripsintThe PTR record

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [interfaces] => Array
                (
                    [0] => Array
                        (
                            [interfaceId] => 0
                            [portId] => 0
                            [portName] => 
                            [vlans] => Array
                                (
                                    [0] => Array
                                        (
                                            [vlanId] => 1295
                                            [prefix] => /24
                                            [gateway] => 31.204.128.1
                                            [netmask] => 255.255.255.0
                                            [type] => ipv4
                                        )

                                    [1] => Array
                                        (
                                            [vlanId] => 1295
                                            [prefix] => /52
                                            [gateway] => 2a00:1630:2:f00::1
                                            [type] => ipv6
                                        )

                                )

                            [ipv4] => Array
                                (
                                    [ips] => Array
                                        (
                                            [0] => Array
                                                (
                                                    [ip] => 31.204.131.39
                                                    [ipType] => normal
                                                    [vlanId] => 1295
                                                    [ptr] => hosted-by.i3d.net
                                                )

                                            [1] => Array
                                                (
                                                    [ip] => 31.204.128.50
                                                    [ipType] => normal
                                                    [vlanId] => 1295
                                                    [ptr] => hosted-by.i3d.net
                                                )

                                        )

                                )

                            [ipv6] => Array
                                (
                                    [ips] => Array
                                        (
                                            [0] => Array
                                                (
                                                    [ip] => 2a00:1630:2:fff::
                                                    [ipType] => normal
                                                    [vlanId] => 1295
                                                    [ptr] => hosted-by.i3d.net
                                                )

                                        )

                                )

                        )

                )

        )

)
POST 
getPtrRecords

Get the PTR records for the IPs of your dedicated server.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
Response parameters
ParameterContextTypeDescription
ptrRecordsarrayPTR records array
ipptrRecordsstringAn IPv4 or IPv6 address
ptrptrRecordsstringThe PTR record

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [ptrRecords] => Array
                (
                    [0] => Array
                        (
                            [ip] => 31.204.128.182
                            [ptr] => hostsed-by-i3d.net.
                        )

                    [1] => Array
                        (
                            [ip] => 31.204.128.183
                            [ptr] => hosted-by.i3d.net.
                        )

                    [2] => Array
                        (
                            [ip] => 31.204.128.184
                            [ptr] => hosted-by.i3d.net.
                        )

                )

        )

)
POST 
setPtrRecords

Set PTR records for the IPs of your dedicated server.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
recordsarrayArray with IP and PTR information
iprecordsarrayAn IP address
ptrrecordsarrayA PTR record for that IP address
Response parameters
ParameterContextTypeDescription
updatesarrayArray containing the result of each record you have submitted
resultupdatesstringOK or Error
msgupdatesstringThe success or error message

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [updates] => Array
                (
                    [0] => Array
                        (
                            [result] => OK
                            [msg] => PTR record for 2a00:1630:2:fff::abc is now mynewptr.example.com
                        )

                )

        )

)
POST 
removePtrRecord

Remove a PTR record.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
ipstringThe IPv4 or IPv6 address you want to remove the PTR of
Response parameters
ParameterContextTypeDescription
resultstringOK or Error
msgstringThe success or error message

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [updates] => Array
                (
                    [0] => Array
                        (
                            [result] => OK
                            [msg] => PTR record for 2a00:1630:2:fff::abc has been removed.
                        )

                )

        )

)

Installation

POST 
getOsList

Get a list of operating systems that you can install.


Request parameters
ParameterContextTypeDescription
dedicatedIdint(optional) - The ID of your dedicated server. The list of OS\s will be filtered to what is available for the server. If omitted, all available OS's will be returned.
Response parameters
ParameterContextTypeDescription
osarrayList of operating systems
idosintThe ID of the operating system
groupIdosintThe ID of the operating system group (1 = Windows, 2 = Linux)
nameosstringThe name of the operating system

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [os] => Array
                (
                    [0] => Array
                        (
                            [id] => 42
                            [groupId] => 2
                            [name] => VMWare ESXi 5.1
                        )

                    [1] => Array
                        (
                            [id] => 49
                            [groupId] => 2
                            [name] => Debian 6
                        )

                    [2] => Array
                        (
                            [id] => 54
                            [groupId] => 2
                            [name] => Ubuntu 10.04 LTS
                        )

                    [3] => Array
                        (
                            [id] => 62
                            [groupId] => 2
                            [name] => CentOS 5.10
                        )

                )

        )

)
POST 
format

Format all drives in a server.


Request parameters
ParameterContextTypeDescription
No parameters
Response parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server.
quickint(optional) set to 1 for a quick format. Otherwise a full disk wipe will be performed.

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [formatStarted] => 1
        )

)
POST 
systemRescue

Boot a server in rescue mode.


Request parameters
ParameterContextTypeDescription
No parameters
Response parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server.
rootPwstringThe root password for the temporary rescue OS. Minimun length: 8 characters.

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [systemRescueStarted] => 1
        )

)
POST 
install

Install a new *NIX operating system.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server.
settingsarrayInstallation settings.
osIdsettingsintThe ID of the *NIX Operating System you want to install. You can get OS ids using the getOsList API call.
osBitssettingsint32 or 64.
osPasswordsettingsstringA (new) root password for logging in after installation.
osHostnamesettingsstringHostname of the server
osPartitioningsettingsarrayextra documentation.
osRaidsettingsarrayextra documentation.
postInstallScriptsettingsstringA bash script that will run after the setup of the operating system is completed.
skipRunoncesettingsbooleanSkip runonce prior to install (not recommended).
i3DcpsettingsintInstall i3Dcp
dellFirmwareUpdatesettingsintOptional, If you set this to 1, the Dell firmware will update.
disableHyperThreadingsettingsintOptional, If you set this to 1, the hyper-threading will be disabled.
Response parameters
ParameterContextTypeDescription
No parameters

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => Array
        (
            [result] => OK
            [msg] => OS Install in progress
        )

)
POST 
install

Install a new Windows operating system.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server.
settingsarrayInstallation settings.
osIdsettingsintThe ID of the Windows operating system. You can get OS ids using the getOsList API call.
osBitssettingsint32 or 64.
osPasswordsettingsintAdministrator password that will be used for the installation.
osHostnamesettingsstringHostname of the server
numHddssettingsintThe number of harddisks you want to create partitions for.
postInstallScriptsettingsstringA powershell script that will run after the setup of the operating system is completed.
skipRunoncesettingsbooleanSkip runonce prior to install (not recommended).
dellFirmwareUpdatesettingsintOptional, If you set this to 1, the Dell firmware will update.
Response parameters
ParameterContextTypeDescription
No parameters

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => Array
        (
            [result] => OK
            [msg] => OS Install in progress
        )

)
POST 
installProgress

Get the installation progress.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
Response parameters
ParameterContextTypeDescription
progressarrayProgress container
percentprogressintProgress percentage
logprogressarrayLog messages

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [progress] => Array
                (
                    [percent] => 10
                    [log] => Array
                        (
                        )

                )

        )

)

Control

POST 
powerStatus

Get the power status (on / off).


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
Response parameters
ParameterContextTypeDescription
powerStatusint0 or 1

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [powerStatus] => Array
                (
                    [powerStatus] => 1
                )

        )

)
POST 
start

Boot dedicated server.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
Response parameters
ParameterContextTypeDescription
startarrayContainer for the result
instructionSentstartint0 or 1

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [start] => Array
                (
                    [instructionSent] => 1
                )

        )

)
POST 
restart

Reboot your dedicated server.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
Response parameters
ParameterContextTypeDescription
restartarrayContainer for the result
instructionSentrestartint0 or 1

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [restart] => Array
                (
                    [instructionSent] => 1
                )

        )

)
POST 
stop

Shut down your dedicated server.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
Response parameters
ParameterContextTypeDescription
stoparrayContainer for the result
instructionSentstopint0 or 1

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [stop] => Array
                (
                    [instructionSent] => 1
                )

        )

)
POST 
getQA

Returns results from automated QA


Request parameters
ParameterContextTypeDescription
serverIdintThe ID of the dedicated server
Response parameters
ParameterContextTypeDescription
qualityAssurancearrayLogs from the QA process

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [qualityAssurance] => Array
                (
                    [0] => Array
                        (
                            [0] => stdClass Object
                                (
                                    [checkId] => 1
                                    [displayName] => Ping BMC IP
                                    [description] => Pings BMC IP address and returns true or false.
                                    [created] => 2018-10-22 15:57:38
                                    [updated] => 2018-10-22 15:57:45
                                    [runtime] => 000005.1924
                                    [result] => Fail
                                    [resultCode] => 2
                                    [logs] => Array
                                        (
                                            [0] => stdClass Object
                                                (
                                                    [message] => PING 10.70.36.6 (10.70.36.6) 56(84) bytes of data.

--- 10.70.36.6 ping statistics ---
1 packets transmitted, 0 received, 100% packet loss, time 0ms

                                                    [timestamp] => 2018-10-24 11:20:09
                                                    [displayName] => Ping BMC IP
                                                    [name] => Server 22626
                                                    [serverId] => 85867
                                                )

                                        )

                                )

                            [1] => stdClass Object
                                (
                                    [checkId] => 3
                                    [displayName] => Login OS
                                    [description] => Login to a servers OS
                                    [created] => 2018-10-22 15:57:38
                                    [updated] => 2018-10-22 15:57:50
                                    [runtime] => 000011.0814
                                    [result] => Fail
                                    [resultCode] => 2
                                    [logs] => Array
                                        (
                                            [0] => stdClass Object
                                                (
                                                    [message] => Failed To Ping
                                                    [timestamp] => 2018-10-24 11:20:09
                                                    [displayName] => Ping OS IP
                                                    [name] => Server 22626
                                                    [serverId] => 85867
                                                )

                                        )

                                )

                        )

                )

        )

)

Administrative

POST 
cancel

Cancel dedicated server.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
Response parameters
ParameterContextTypeDescription
ticketarrayContainer for the result
hashticketstringConfirmation ticket hash

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [ticket] => Array
                (
                    [hash] => T-652-VT2T
                )

        )

)
POST 
renew

Renew dedicated server.


Request parameters
ParameterContextTypeDescription
dedicatedIdintThe ID of the dedicated server
Response parameters
ParameterContextTypeDescription
ticketarrayContainer for the result
hashticketstringConfirmation ticket hash

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [ticket] => Array
                (
                    [hash] => T-653-QS7P
                )

        )

)
POST 
getLocations

Get all location names and IDs.


Request parameters
ParameterContextTypeDescription
No parameters
Response parameters
ParameterContextTypeDescription
locationsarrayContainer for all locations
idlocationsintID of the location
namelocationsstringThe name of the location
shortNamelocationsstringThe short name of the location

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [locations] => Array
                (
                    [0] => Array
                        (
                            [id] => 3
                            [name] => Frankfurt: DE
                            [shortName] => fra
                        )

                    [1] => Array
                        (
                            [id] => 18
                            [name] => Rotterdam: NL
                            [shortName] => rtm
                        )

                )

        )

)