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": "_USER-ID_","apiKey": "_API-KEY_", "dedicatedId": "_ID_","action": "setLabels","labels": [{"key": "release","value": null}}]}
Actions
| Parameter | Context | Type | Description |
|---|---|---|---|
| No parameters | |||
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedIds | array | All 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).
| Parameter | Context | Type | Description |
|---|---|---|---|
| No parameters | |||
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedServers | array | List of dedicated servers | serverId | dedicatedServers | int | The ID of the server | isVirtual | dedicatedServers | int | 0: bare metal server, 1: virtual server | dedicatedId | dedicatedServers | int | The ID of the dedicated server | dediserverName | dedicatedServers | string | The name of the server | projectName | dedicatedServers | string | The project name of the server (usually the name of a collection of servers) | clientServerName | dedicatedServers | string | The name of the server you enter yourself | clientState | dedicatedServers | string | The state of the server you enter yourself | BMCtype | dedicatedServers | string | The BMC port type (0 = shared, 1 = dedicated) | liveHostname | dedicatedServers | string | Live host name of the physical server | categoryName | dedicatedServers | string | The category name for the server | locationId | dedicatedServers | int | Location ID | location | dedicatedServers | string | Location name | rackId | dedicatedServers | int | Rack ID | rackName | dedicatedServers | string | Rack name | status | dedicatedServers | string | The power status of the server | userId | dedicatedServers | int | The owner userId of the dedicated server | supporttag | dedicatedServers | string | The supporttag of the server | i3dServerMonitorVersion | dedicatedServers | string | i3D.net Server Monitor version string - Only for premium users | i3dServerMonitorCheckVersion | dedicatedServers | string | i3D.net Server Monitor Check version string - Only for premium users | i3dServerMonitorLastCheckIn | dedicatedServers | string | i3D.net Server Monitor last checkin timestamp - Only for premium users | purchaseOrder | dedicatedServers | string | Purchase order reference | trafficUsed | dedicatedServers | int | Used traffic in GB | trafficUsedDailyAve | dedicatedServers | int | Traffic usage, averaged by day, in GB | trafficTotal | dedicatedServers | string | Total committed traffic, in GB | serverCase | dedicatedServers | string | Brand and type of the chassis | numCpu | dedicatedServers | int | The number of CPUs in the chassis | cpuInfo | dedicatedServers | string | CPU information | cpuType | dedicatedServers | string | CPU type | cpuAll | dedicatedServers | array | Individual CPU information | cpuInfo | cpuAll | string | CPU information | cpuClockSpeed | cpuAll | int | CPU clock speed in MHz | cpuType | cpuAll | string | CPU type | memoryInfo | dedicatedServers | array | Information for each memory bank | hdInfo | dedicatedServers | array | Information about each hard drive | vdInfo | dedicatedServers | array | Information about each virtual drive | pciInfo | dedicatedServers | array | Information on optional PCI cards (usually RAID card) | dvdInfo | dedicatedServers | string | Brand and type of CD / DVD drive, if any | networkAdapter | dedicatedServers | string | Network adapter brand and type | osId | dedicatedServers | int | Operating System ID (see getOsList) | osName | dedicatedServers | string | Operating System name | ip | dedicatedServers | string | The (first) IP of the server | bmcIp | dedicatedServers | string | The KVM IP of the server, if it is assigned one | contractStart | dedicatedServers | string | The start date of the contract | contractEnd | dedicatedServers | string | The end date of the contract | dateCancelled | dedicatedServers | string | The date on which the server has been cancelled, if it has been cancelled | monthlyCost | dedicatedServers | string | Cost per month | status | dedicatedServers | string | The BMC (management) status (Online / Offline / BMC Not Installed / BMC Failed) | uptime | dedicatedServers | in | Uptime in seconds | cpuLoad | dedicatedServers | int | CPU load | memMax | dedicatedServers | int | Maximum available memory | hddSpace | dedicatedServers | int | Total available drive space | labels | dedicatedServers | array | Custom 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] => _ID_
[isVirtual] => 0
[dedicatedId] => _ID_
[dediserverName] => _SERVER-NAME_
[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
[userId] => _USER-ID_
[supporttag] => _SUPPORTTAG_
[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] => 203.0.113.2
[contractStart] => 30 Aug 2013
[contractEnd] => 01 Oct 2019
[dateCancelled] =>
[monthlyCost] => 60 Euro
[status] => Online
[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.
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server | trafficDays | int | (optional) returns daily traffic usage if larger than 0 (max. 30) PLEASE NOTE: you are limited to 12 traffic requests per minute. |
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedServers | array | List of dedicated servers | serverId | dedicatedServers | int | The ID of the server | isVirtual | dedicatedServers | int | 0: bare metal server, 1: virtual server | dedicatedId | dedicatedServers | int | The ID of the dedicated server | dediserverName | dedicatedServers | string | The name of the server | clientState | dedicatedServers | string | The state of the server you enter yourself | projectName | dedicatedServers | string | The project name of the server (usually the name of a collection of servers) | clientServerName | dedicatedServers | string | The name of the server you enter yourself | BMCtype | dedicatedServers | string | The BMC port type (0 = shared, 1 = dedicated) | liveHostname | dedicatedServers | string | Live host name of the physical server | categoryName | dedicatedServers | string | The category name for the server | locationId | dedicatedServers | int | Location ID | location | dedicatedServers | string | Location name | rackId | dedicatedServers | int | Rack ID | rackName | dedicatedServers | string | Rack name | status | dedicatedServers | string | The power status of the server | userId | dedicatedServers | int | The owner userId of the dedicated server | supporttag | dedicatedServers | string | The supporttag of the server | i3dServerMonitorVersion | dedicatedServers | string | i3D.net Server Monitor version string - Only for premium users | i3dServerMonitorCheckVersion | dedicatedServers | string | i3D.net Server Monitor Check version string - Only for premium users | i3dServerMonitorLastCheckIn | dedicatedServers | string | i3D.net Server Monitor last checkin timestamp - Only for premium users | purchaseOrder | dedicatedServers | string | Purchase order reference | trafficUsed | dedicatedServers | int | Used traffic in GB | trafficUsedDailyAve | dedicatedServers | int | Traffic usage, averaged by day, in GB | trafficTotal | dedicatedServers | string | Total committed traffic, in GB | serverCase | dedicatedServers | string | Brand and type of the chassis | cpuInfo | dedicatedServers | string | CPU information | cpuType | dedicatedServers | string | CPU type | cpuAll | dedicatedServers | array | Individual CPU information | cpuInfo | cpuAll | string | CPU information | cpuClockSpeed | cpuAll | int | CPU clock speed in MHz | cpuType | cpuAll | string | CPU type | memoryInfo | dedicatedServers | array | Information for each memory bank | hdInfo | dedicatedServers | array | Information about each hard drive | vdInfo | dedicatedServers | array | Information about each virtual drive | pciInfo | dedicatedServers | array | Information on optional PCI cards (usually RAID card) | dvdInfo | dedicatedServers | string | Brand and type of CD / DVD drive, if any | networkAdapter | dedicatedServers | string | Network adapter brand and type | osId | dedicatedServers | string | Operating System ID (see getOsList) | osName | dedicatedServers | string | Operating System name | ip | dedicatedServers | string | The (first) IP of the server | bmcIp | dedicatedServers | string | The KVM IP of the server, if it is assigned one | contractStart | dedicatedServers | string | The start date of the contract | contractEnd | dedicatedServers | string | The end date of the contract | dateCancelled | dedicatedServers | string | The date on which the server has been cancelled, if it has been cancelled | monthlyCost | dedicatedServers | string | Cost per month | status | dedicatedServers | string | The BMC (management) status (Online / Offline / BMC Not Installed / BMC Failed) | uptime | dedicatedServers | in | Uptime in seconds | cpuLoad | dedicatedServers | int | CPU load | memFree | dedicatedServers | int | Free memory in MB | memMax | dedicatedServers | int | Maximum available memory | hddSpace | dedicatedServers | int | Total available drive space | hddFree | dedicatedServers | int | Remaining free drive space | trafficDetails | dedicatedServers | array | Array of network links and their daily traffic stats. | linkName | trafficDetails | string | Name of the link - container for traffic history | date | linkName | string | Traffic date | in | linkName | float | Incoming traffic | out | linkName | float | Outgoing traffic |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[dedicatedServer] => Array
(
[serverId] => _ID_
[isVirtual] => 0
[dedicatedId] => _ID_
[dediserverName] => _SERVER-NAME_
[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
[userId] => _USER-ID_
[supporttag] => _SUPPORTTAG_
[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] => 203.0.113.2
[contractStart] => 30 Aug 2013
[contractEnd] => 01 Oct 2019
[dateCancelled] =>
[monthlyCost] => 60 Euro
[status] => Online
[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
| Parameter | Context | Type | Description |
|---|---|---|---|
| filters | array | Array of search values. example: ["servername" => "_SERVER-NAME_", "ip" => "203.0.113.2", "serverId" => "_ID_", "dedicatedId" => "_ID_", "supporttag" => "_SUPPORTTAG_"] |
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedServers | array | List of dedicated servers | serverId | dedicatedServers | int | The ID of the server | isVirtual | dedicatedServers | int | 0: bare metal server, 1: virtual server | dedicatedId | dedicatedServers | int | The ID of the dedicated server | dediserverName | dedicatedServers | string | The name of the server | clientState | dedicatedServers | string | The state of the server you enter yourself | projectName | dedicatedServers | string | The project name of the server (usually the name of a collection of servers) | clientServerName | dedicatedServers | string | The name of the server you enter yourself | BMCtype | dedicatedServers | string | The BMC port type (0 = shared, 1 = dedicated) | liveHostname | dedicatedServers | string | Live host name of the physical server | categoryName | dedicatedServers | string | The category name for the server | locationId | dedicatedServers | int | Location ID | location | dedicatedServers | string | Location name | rackId | dedicatedServers | int | Rack ID | rackName | dedicatedServers | string | Rack name | status | dedicatedServers | string | The power status of the server | userId | dedicatedServers | int | The owner userId of the dedicated server | supporttag | dedicatedServers | string | The supporttag of the server | i3dServerMonitorVersion | dedicatedServers | string | i3D.net Server Monitor version string - Only for premium users | i3dServerMonitorCheckVersion | dedicatedServers | string | i3D.net Server Monitor Check version string - Only for premium users | i3dServerMonitorLastCheckIn | dedicatedServers | string | i3D.net Server Monitor last checkin timestamp - Only for premium users | purchaseOrder | dedicatedServers | string | Purchase order reference | trafficUsed | dedicatedServers | int | Used traffic in GB | trafficUsedDailyAve | dedicatedServers | int | Traffic usage, averaged by day, in GB | trafficTotal | dedicatedServers | string | Total committed traffic, in GB | serverCase | dedicatedServers | string | Brand and type of the chassis | cpuInfo | dedicatedServers | string | CPU information | cpuType | dedicatedServers | string | CPU type | cpuAll | dedicatedServers | array | Individual CPU information | cpuInfo | cpuAll | string | CPU information | cpuClockSpeed | cpuAll | int | CPU clock speed in MHz | cpuType | cpuAll | string | CPU type | memoryInfo | dedicatedServers | array | Information for each memory bank | hdInfo | dedicatedServers | array | Information about each hard drive | vdInfo | dedicatedServers | array | Information about each virtual drive | pciInfo | dedicatedServers | array | Information on optional PCI cards (usually RAID card) | dvdInfo | dedicatedServers | string | Brand and type of CD / DVD drive, if any | networkAdapter | dedicatedServers | string | Network adapter brand and type | osId | dedicatedServers | string | Operating System ID (see getOsList) | osName | dedicatedServers | string | Operating System name | ip | dedicatedServers | string | The (first) IP of the server | bmcIp | dedicatedServers | string | The KVM IP of the server, if it is assigned one | contractStart | dedicatedServers | string | The start date of the contract | contractEnd | dedicatedServers | string | The end date of the contract | dateCancelled | dedicatedServers | string | The date on which the server has been cancelled, if it has been cancelled | monthlyCost | dedicatedServers | string | Cost per month | status | dedicatedServers | string | The BMC (management) status (Online / Offline / BMC Not Installed / BMC Failed) | uptime | dedicatedServers | in | Uptime in seconds | cpuLoad | dedicatedServers | int | CPU load | memFree | dedicatedServers | int | Free memory in MB | memMax | dedicatedServers | int | Maximum available memory | hddSpace | dedicatedServers | int | Total available drive space | hddFree | dedicatedServers | int | Remaining free drive space | labels | dedicatedServers | array | Custom key/value pairs that can be used for filtering dedicated servers. |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[dedicatedServer] => Array
(
[serverId] => _ID_
[isVirtual] => 0
[dedicatedId] => _ID_
[dediserverName] => _SERVER-NAME_
[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
[userId] => _USER-ID_
[supporttag] => _SUPPORTTAG_
[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] => 203.0.113.2
[contractStart] => 30 Aug 2013
[contractEnd] => 01 Oct 2019
[dateCancelled] =>
[monthlyCost] => 60 Euro
[status] => Online
[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.
| Parameter | Context | Type | Description |
|---|---|---|---|
| incGameServerDetails | int | Also include all details of the game instances on the dedicated server (0 or 1). |
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedServers | array | List of dedicated servers | serverId | dedicatedServers | int | The ID of the server | isVirtual | dedicatedServers | int | 0: bare metal server, 1: virtual server | dedicatedId | dedicatedServers | int | The ID of the dedicated server | dediserverName | dedicatedServers | string | The name of the server | projectName | dedicatedServers | string | The project name of the server (usually the name of a collection of servers) | clientServerName | dedicatedServers | string | The name of the server you enter yourself | clientState | dedicatedServers | string | The state of the server you enter yourself | BMCtype | dedicatedServers | string | The BMC port type (0 = shared, 1 = dedicated) | liveHostname | dedicatedServers | string | Live host name of the physical server | categoryName | dedicatedServers | string | The category name for the server | locationId | dedicatedServers | int | Location ID | location | dedicatedServers | string | Location name | rackId | dedicatedServers | int | Rack ID | rackName | dedicatedServers | string | Rack name | status | dedicatedServers | string | The power status of the server | userId | dedicatedServers | int | The owner userId of the dedicated server | supporttag | dedicatedServers | string | The supporttag of the server | i3dServerMonitorVersion | servers | string | i3D.net Server Monitor version string - Only for premium users | i3dServerMonitorCheckVersion | servers | string | i3D.net Server Monitor Check version string - Only for premium users | i3dServerMonitorLastCheckIn | servers | string | i3D.net Server Monitor last checkin timestamp - Only for premium users | purchaseOrder | servers | string | Purchase order reference | trafficUsed | dedicatedServers | int | Used traffic in GB | trafficUsedDailyAve | dedicatedServers | int | Traffic usage, averaged by day, in GB | trafficTotal | dedicatedServers | string | Total committed traffic, in GB | serverCase | dedicatedServers | string | Brand and type of the chassis | cpuInfo | dedicatedServers | string | CPU information | cpuType | dedicatedServers | string | CPU type | cpuAll | dedicatedServers | array | Individual CPU information | cpuInfo | cpuAll | string | CPU information | cpuClockSpeed | cpuAll | int | CPU clock speed in MHz | cpuType | cpuAll | string | CPU type | memoryInfo | dedicatedServers | array | Information for each memory bank | vdInfo | dedicatedServers | array | Information about each hard drive | pciInfo | dedicatedServers | array | Information on optional PCI cards (usually RAID card) | dvdInfo | dedicatedServers | string | Brand and type of CD / DVD drive, if any | networkAdapter | dedicatedServers | string | Network adapter brand and type | osId | dedicatedServers | string | Operating System ID (see getOsList) | osName | dedicatedServers | string | Operating System name | ip | dedicatedServers | string | The (first) IP of the server | bmcIp | dedicatedServers | string | The KVM IP of the server, if it is assigned one | contractStart | dedicatedServers | string | The start date of the contract | contractEnd | dedicatedServers | string | The end date of the contract | dateCancelled | dedicatedServers | string | The date on which the server has been cancelled, if it has been cancelled | monthlyCost | dedicatedServers | string | Cost per month | status | dedicatedServers | string | The BMC (management) status (Online / Offline / BMC Not Installed / BMC Failed) | uptime | dedicatedServers | in | Uptime in seconds | cpuLoad | dedicatedServers | int | CPU load | memFree | dedicatedServers | int | Free memory in MB | memMax | dedicatedServers | int | Maximum available memory | hddSpace | dedicatedServers | int | Total available drive space | hddFree | dedicatedServers | int | Remaining free drive space | gameserverStats | dedicatedServers | array | List of simple game stats / counters per dedicated server, per game | <GAMEID> | gameserverStats | int | Game stats per game ID | numGameserversOnline | <GAMEID> | int | Number of online game servers | numGameserversOffline | <GAMEID> | int | Number of offline game servers | numLivePlayers | <GAMEID> | int | Number of players currently on the servers. | gameserverDetails | dedicatedServers | array | Full details of all game instances hosted on the servers (if incGameServerDetails = 1) | labels | dedicatedServers | array | Custom 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] => _ID_
[isVirtual] => 0
[dedicatedId] => _ID_
[dediserverName] => _SERVER-NAME_
[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] => _USER-ID_
[supporttag] => _SUPPORTTAG_
[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] => 203.0.113.2
[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
)
)
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server |
| Parameter | Context | Type | Description |
|---|---|---|---|
| setDetails | array | List of details you provided | projectName | setDetails | string | The project name as you entered it | clientServerName | setDetails | string | The client server name as you entered it | clientState | setDetails | string | The 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
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server | projectName | string | Your project name (often a name to identify a collection of servers) (max 100 chars) | clientServerName | string | Your own name for a dedicated server | clientState | string | Your defined state for a dedicated server |
| Parameter | Context | Type | Description |
|---|---|---|---|
| setDetails | array | List of details you provided | projectName | setDetails | string | The project name as you entered it | clientServerName | setDetails | string | The client server name as you entered it | clientState | setDetails | string | The 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
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server | labels | array | Custom key/value pairs that can be used for filtering dedicated servers. E.g. "labels": [ { "key": "labelkey", "value": "label value" } ] |
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedServers | array | List of dedicated servers | serverId | dedicatedServers | int | The ID of the server | isVirtual | dedicatedServers | int | 0: bare metal server, 1: virtual server | dedicatedId | dedicatedServers | int | The ID of the dedicated server | dediserverName | dedicatedServers | string | The name of the server | projectName | dedicatedServers | string | The project name of the server (usually the name of a collection of servers) | clientServerName | dedicatedServers | string | The name of the server you enter yourself | clientState | dedicatedServers | string | The state of the server you enter yourself | BMCtype | dedicatedServers | string | The BMC port type (0 = shared, 1 = dedicated) | liveHostname | dedicatedServers | string | Live host name of the physical server | categoryName | dedicatedServers | string | The category name for the server | locationId | dedicatedServers | int | Location ID | location | dedicatedServers | string | Location name | rackId | dedicatedServers | int | Rack ID | rackName | dedicatedServers | string | Rack name | status | dedicatedServers | string | The power status of the server | userId | dedicatedServers | int | The owner userId of the dedicated server | supporttag | dedicatedServers | string | The supporttag of the server | i3dServerMonitorVersion | dedicatedServers | string | i3D.net Server Monitor version string - Only for premium users | i3dServerMonitorCheckVersion | dedicatedServers | string | i3D.net Server Monitor Check version string - Only for premium users | i3dServerMonitorLastCheckIn | dedicatedServers | string | i3D.net Server Monitor last checkin timestamp - Only for premium users | purchaseOrder | dedicatedServers | string | Purchase order reference | trafficUsed | dedicatedServers | int | Used traffic in GB | trafficUsedDailyAve | dedicatedServers | int | Traffic usage, averaged by day, in GB | trafficTotal | dedicatedServers | string | Total committed traffic, in GB | serverCase | dedicatedServers | string | Brand and type of the chassis | numCpu | dedicatedServers | int | The number of CPUs in the chassis | cpuInfo | dedicatedServers | string | CPU information | cpuType | dedicatedServers | string | CPU type | cpuAll | dedicatedServers | array | Individual CPU information | cpuInfo | cpuAll | string | CPU information | cpuClockSpeed | cpuAll | int | CPU clock speed in MHz | cpuType | cpuAll | string | CPU type | memoryInfo | dedicatedServers | array | Information for each memory bank | hdInfo | dedicatedServers | array | Information about each hard drive | vdInfo | dedicatedServers | array | Information about each virtual drive | pciInfo | dedicatedServers | array | Information on optional PCI cards (usually RAID card) | dvdInfo | dedicatedServers | string | Brand and type of CD / DVD drive, if any | networkAdapter | dedicatedServers | string | Network adapter brand and type | osId | dedicatedServers | int | Operating System ID (see getOsList) | osName | dedicatedServers | string | Operating System name | ip | dedicatedServers | string | The (first) IP of the server | bmcIp | dedicatedServers | string | The KVM IP of the server, if it is assigned one | contractStart | dedicatedServers | string | The start date of the contract | contractEnd | dedicatedServers | string | The end date of the contract | dateCancelled | dedicatedServers | string | The date on which the server has been cancelled, if it has been cancelled | monthlyCost | dedicatedServers | string | Cost per month | status | dedicatedServers | string | The BMC (management) status (Online / Offline / BMC Not Installed / BMC Failed) | uptime | dedicatedServers | in | Uptime in seconds | cpuLoad | dedicatedServers | int | CPU load | memMax | dedicatedServers | int | Maximum available memory | hddSpace | dedicatedServers | int | Total available drive space | labels | dedicatedServers | array | Custom 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] => _ID_
[isVirtual] => 0
[dedicatedId] => _ID_
[dediserverName] => _SERVER-NAME_
[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] => _USER-ID_
[supporttag] => _SUPPORTTAG_
[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] => 203.0.113.2
[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.
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server | incGraph | int | (optional) Include graph image data if 1. PLEASE NOTE: you are limited to 12 traffic requests per minute. | dateStart | string | The start date of fetched traffic in format: DD-MM-YYYY (optional) | dateEnd | string | The end date of fetched traffic in format: DD-MM-YYYY (optional) |
| Parameter | Context | Type | Description |
|---|---|---|---|
| traffic | array | List of network interfaces and their traffic. | linkName | traffic | array | Traffic data per day, for 3 months. | date | linkName | string | The date of the day holding the stats. | in | linkName | float | Incoming traffic for that day. | out | linkName | float | Outgoing 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.
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server. PLEASE NOTE: you are limited to 12 traffic requests per minute. | dateStart | string | The start date of fetched traffic in format: DD-MM-YYYY (optional) | dateEnd | string | The end date of fetched traffic in format: DD-MM-YYYY (optional) |
| Parameter | Context | Type | Description |
|---|---|---|---|
| traffic | linkX | traffic | The link for which the graphs are presented. | graphDay | linkX | base64encoded | Traffic graph of the last 24 hours. | graphWeek | linkX | base64encoded | Traffic graph of the last week. | graphMonth | linkX | base64encoded | Traffic graph of the last month. | graphYear | linkX | base64encoded | Traffic 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)
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server |
| Parameter | Context | Type | Description |
|---|---|---|---|
| alerts | array | Alerts array | id | alerts | int | The ID of the alert | percentage | alerts | int | The percentage at which the alert will be triggered | emailOnAlert | alerts | int | 0 - 1, whether to receive an email on alert | ticketOnAlert | alerts | int | 0 - 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
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server | alerts | array | id | alerts | int | The ID of the alert | percentage | alerts | int | The percentage at which the alert will be triggered | emailOnAlert | alerts | int | 0 - 1, whether to receive an email on alert (if this is set, you cannot set ticketOnAlert) | ticketOnAlert | alerts | int | 0 - 1, whether to receive a ticket on alert (if this is set, you cannot set emailOnAlert) | remove | alerts | int | (optional) if 1, remove this entry |
| Parameter | Context | Type | Description |
|---|---|---|---|
| updates | array | Array of update results | result | updates | string | OK or Error | msg | updates | string | If 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.
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server |
| Parameter | Context | Type | Description |
|---|---|---|---|
| interfaces | array | Array of network details for every interface | vlans | interfaces | array | Contains vlan network information | vlanId | vlans | int | The vlan ID | gateway | vlans | string | Gateway IP | netmask | vlans | string | IPv4 netmask (not present for IPv6) | type | vlans | string | Defines vlan IP version either IPv4 or IPv6 | prefix | vlans | string | CIDR prefix, includes leading slash (/) | ipv4 | interfaces | array | Contains IPv4 network information | ipv6 | interfaces | array | Contains IPv6 network information | ips | ipv4/ipv6 | array | IP information | ip | ips | string | An IP address | ipType | ips | string | IP type (kvm / normal) | vlanId | ips | int | The vlan ID | ptr | ips | int | The 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] => 2001:db8::13::1
[type] => ipv6
)
)
[ipv4] => Array
(
[ips] => Array
(
[0] => Array
(
[ip] => 203.0.113.2
[ipType] => normal
[vlanId] => 1234
[ptr] => hosted-by.i3d.net
)
[1] => Array
(
[ip] => 203.0.113.3
[ipType] => normal
[vlanId] => 1234
[ptr] => hosted-by.i3d.net
)
)
)
[ipv6] => Array
(
[ips] => Array
(
[0] => Array
(
[ip] => 2001:db8::13::
[ipType] => normal
[vlanId] => 1234
[ptr] => hosted-by.i3d.net
)
)
)
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server |
| Parameter | Context | Type | Description |
|---|---|---|---|
| ptrRecords | array | PTR records array | ip | ptrRecords | string | An IPv4 or IPv6 address | ptr | ptrRecords | string | The PTR record |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[ptrRecords] => Array
(
[0] => Array
(
[ip] => 203.0.113.2
[ptr] => hostsed-by-i3d.net.
)
[1] => Array
(
[ip] => 203.0.113.3
[ptr] => hosted-by.i3d.net.
)
[2] => Array
(
[ip] => 203.0.113.4
[ptr] => hosted-by.i3d.net.
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server | records | array | Array with IP and PTR information | ip | records | array | An IP address | ptr | records | array | A PTR record for that IP address |
| Parameter | Context | Type | Description |
|---|---|---|---|
| updates | array | Array containing the result of each record you have submitted | result | updates | string | OK or Error | msg | updates | string | The success or error message |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[updates] => Array
(
[0] => Array
(
[result] => OK
[msg] => PTR record for 2001:db8::13::48 is now mynewptr.example.com
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server | ip | string | The IPv4 or IPv6 address you want to remove the PTR of |
| Parameter | Context | Type | Description |
|---|---|---|---|
| result | string | OK or Error | msg | string | The success or error message |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[updates] => Array
(
[0] => Array
(
[result] => OK
[msg] => PTR record for 2001:db8::13::48 has been removed.
)
)
)
)
Installation
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | (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. |
| Parameter | Context | Type | Description |
|---|---|---|---|
| os | array | List of operating systems | id | os | int | The ID of the operating system | groupId | os | int | The ID of the operating system group (1 = Windows, 2 = Linux) | name | os | string | The 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
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| No parameters | |||
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server. | quick | int | (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
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| No parameters | |||
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server. | rootPw | string | The root password for the temporary rescue OS. Minimum length: 8 characters. |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[systemRescueStarted] => 1
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server. | settings | array | Installation settings. | osId | settings | int | The ID of the *NIX Operating System you want to install. You can get OS ids using the getOsList API call. | osBits | settings | int | 32 or 64. | osPassword | settings | string | A (new) root password for logging in after installation. | osHostname | settings | string | Hostname of the server | osPartitioning | settings | array | extra documentation. | osRaid | settings | array | extra documentation. | postInstallScript | settings | string | A bash script that will run after the setup of the operating system is completed. | skipRunonce | settings | boolean | Skip runonce prior to install (not recommended). | i3Dcp | settings | int | Install i3Dcp | dellFirmwareUpdate | settings | int | Optional, If you set this to 1, the Dell firmware will update. | disableHyperThreading | settings | int | Optional, If you set this to 1, the hyper-threading will be disabled. |
| Parameter | Context | Type | Description |
|---|---|---|---|
| No parameters | |||
Example
Array
(
[status] => Success
[msg] => OK
[data] => Array
(
[result] => OK
[msg] => OS Install in progress
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server. | settings | array | Installation settings. | osId | settings | int | The ID of the Windows operating system. You can get OS ids using the getOsList API call. | osBits | settings | int | 32 or 64. | osPassword | settings | int | Administrator password that will be used for the installation. | osHostname | settings | string | Hostname of the server | numHdds | settings | int | The number of harddisks you want to create partitions for. | postInstallScript | settings | string | A powershell script that will run after the setup of the operating system is completed. | skipRunonce | settings | boolean | Skip runonce prior to install (not recommended). | dellFirmwareUpdate | settings | int | Optional, If you set this to 1, the Dell firmware will update. |
| Parameter | Context | Type | Description |
|---|---|---|---|
| No parameters | |||
Example
Array
(
[status] => Success
[msg] => OK
[data] => Array
(
[result] => OK
[msg] => OS Install in progress
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server |
| Parameter | Context | Type | Description |
|---|---|---|---|
| progress | array | Progress container | percent | progress | int | Progress percentage | log | progress | array | Log messages |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[progress] => Array
(
[percent] => 10
[log] => Array
(
)
)
)
)
Control
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server |
| Parameter | Context | Type | Description |
|---|---|---|---|
| powerStatus | int | 0 or 1 |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[powerStatus] => Array
(
[powerStatus] => 1
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server |
| Parameter | Context | Type | Description |
|---|---|---|---|
| start | array | Container for the result | instructionSent | start | int | 0 or 1 |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[start] => Array
(
[instructionSent] => 1
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server |
| Parameter | Context | Type | Description |
|---|---|---|---|
| restart | array | Container for the result | instructionSent | restart | int | 0 or 1 |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[restart] => Array
(
[instructionSent] => 1
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server |
| Parameter | Context | Type | Description |
|---|---|---|---|
| stop | array | Container for the result | instructionSent | stop | int | 0 or 1 |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[stop] => Array
(
[instructionSent] => 1
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| serverId | int | The ID of the dedicated server |
| Parameter | Context | Type | Description |
|---|---|---|---|
| qualityAssurance | array | Logs 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] => _ID_
)
)
)
[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] => _ID_
)
)
)
)
)
)
)
Administrative
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server |
| Parameter | Context | Type | Description |
|---|---|---|---|
| ticket | array | Container for the result | hash | ticket | string | Confirmation ticket hash |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[ticket] => Array
(
[hash] => T-652-VT2T
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| dedicatedId | int | The ID of the dedicated server |
| Parameter | Context | Type | Description |
|---|---|---|---|
| ticket | array | Container for the result | hash | ticket | string | Confirmation ticket hash |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[ticket] => Array
(
[hash] => T-653-QS7P
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| No parameters | |||
| Parameter | Context | Type | Description |
|---|---|---|---|
| locations | array | Container for all locations | id | locations | int | ID of the location | name | locations | string | The name of the location | shortName | locations | string | The 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
)
)
)
)