This page describes all the API calls you can make to get information and control your colocation service(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.
Actions
Request parameters
| Parameter | Context | Type | Description |
|---|---|---|---|
| No parameters | |||
| Parameter | Context | Type | Description |
|---|---|---|---|
| colocations | array | All your colocation services. | coloserverId | colocations | int | The ID of the colocation service | rackName | colocations | string | The name / location of the rack | trafficUsed | colocations | float | Traffic used in the current contract period | trafficUsedDailyAve | colocations | float | Daily traffic average | contractTraffic | colocations | int | Contract traffic bought upfront | contractMaxAmp | colocations | int | Contract maximum amperage usage | contractStart | colocations | string | Contract start date | contractEnd | colocations | string | Contract end date | contractInvoicedUntil | colocations | string | Contract invoiced until date | contractCancelDate | colocations | string | Contract cancel date if contract is cancelled | monthlyCost | colocations | string | Monthly cost | units | colocations | int | Amount of units rented | pdus | colocations | array | List of PDUs | lastUpdate | pdus | int | Last updated values timestamp | serialNumber | pdus | string | PDU serial number | totalKWH | pdus | int | PDU current kWh meter | powerFactor | pdus | string | PDU current power factor in percentage | ampNow | pdus | string | PDU current amperage usage | ampPeak | pdus | string | PDU highest amerage peak | ampMax | pdus | string | PDU max usable amperage | voltNow | pdus | string | PDU current voltage | voltMin | pdus | string | PDU voltage trough | numberOfPhases | pdus | int | PDU number of phases | numberOfOutlets | pdus | int | PDU number of outlets | feeds | pdus | array | List of all feeds for this PDU | outletNumber | feeds | int | Feed outlet number | totalKWH | feeds | int | Feed current kWh meter | ampNow | feeds | string | Feed current amperage usage | ampPeak | feeds | string | Feed highest amerage peak | voltNow | feeds | string | Feed current voltage | voltMin | feeds | string | Feed voltage trough | powerFactor | feeds | string | Feed current power factor in percentage |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[colocations] => Array
(
[0] => Array
(
[coloserverId] => 573
[rackName] => Suite 08 - Rack 32
[trafficUsed] => 100
[trafficUsedDailyAve] => 33.33
[contractTraffic] => 1000
[contractMaxAmp] => 32
[contractStart] => 19 Jul 2013
[contractEnd] => 01 Aug 2020
[contractInvoicedUntil] => 19 Aug 2014
[contractCancelDate] => 07 Oct 2014
[monthlyCost] => 112 Euro
[units] => 46
[pdus] => Array
(
[0] => Array
(
[lastUpdate] => 1414519287
[serialNumber] => SVNL00006722
[totalKWH] => 10239
[powerFactor] => 99.99
[ampNow] => 12.0
[ampPeak] => 22.5
[ampMax] => 31.5
[voltNow] => 235.5
[voltMin] => 228.2
[numberOfPhases] => 1
[numberOfOutlets] => 3
[feeds] => Array
(
[0] => Array
(
[outletNumber] => 1
[totalKWH] => 4242
[ampNow] => 1.20
[ampPeak] => 6.8
[voltNow] => 235.5
[voltMin] => 228.2
[powerFactor] => 99.99
)
[1] => Array
(
[outletNumber] => 2
[totalKWH] => 2102
[ampNow] => 2.30
[ampPeak] => 5.5
[voltNow] => 235.5
[voltMin] => 228.2
[powerFactor] => 99.99
)
[2] => Array
(
[outletNumber] => 3
[totalKWH] => 80
[ampNow] => 5.50
[ampPeak] => 10.2
[voltNow] => 235.5
[voltMin] => 228.2
[powerFactor] => 99.99
)
)
)
)
)
)
)
)
Request parameters
| Parameter | Context | Type | Description |
|---|---|---|---|
| colocationId | int | The ID of the colocation service |
| Parameter | Context | Type | Description |
|---|---|---|---|
| colocation | array | All your colocation services. | coloserverId | colocations | int | The ID of the colocation service | rackName | colocations | string | The name / location of the rack | trafficUsed | colocations | float | Traffic used in the current contract period | trafficUsedDailyAve | colocations | float | Daily traffic average | contractTraffic | colocations | int | Contract traffic bought upfront | contractMaxAmp | colocations | int | Contract maximum amperage usage | contractStart | colocations | string | Contract start date | contractEnd | colocations | string | Contract end date | contractInvoicedUntil | colocations | string | Contract invoiced until date | contractCancelDate | colocations | string | Contract cancel date if contract is cancelled | monthlyCost | colocations | string | Monthly cost | units | colocations | int | Amount of units rented | pdus | colocations | array | List of PDUs | lastUpdate | pdus | int | Last updated values timestamp | serialNumber | pdus | string | PDU serial number | totalKWH | pdus | int | PDU current kWh meter | powerFactor | pdus | string | PDU current power factor in percentage | ampNow | pdus | string | PDU current amperage usage | ampPeak | pdus | string | PDU highest amerage peak | ampMax | pdus | string | PDU max usable amperage | voltNow | pdus | string | PDU current voltage | voltMin | pdus | string | PDU voltage trough | numberOfPhases | pdus | int | PDU number of phases | numberOfOutlets | pdus | int | PDU number of outlets | feeds | pdus | array | List of all feeds for this PDU | outletNumber | feeds | int | Feed outlet number | totalKWH | feeds | int | Feed current kWh meter | ampNow | feeds | string | Feed current amperage usage | ampPeak | feeds | string | Feed highest amerage peak | voltNow | feeds | string | Feed current voltage | voltMin | feeds | string | Feed voltage trough | powerFactor | feeds | string | Feed current power factor in percentage |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[colocations] => Array
(
[0] => Array
(
[coloserverId] => 573
[rackName] => Suite 08 - Rack 32
[trafficUsed] => 100
[trafficUsedDailyAve] => 33.33
[contractTraffic] => 1000
[contractMaxAmp] => 32
[contractStart] => 19 Jul 2013
[contractEnd] => 01 Aug 2020
[contractInvoicedUntil] => 19 Aug 2014
[contractCancelDate] => 07 Oct 2014
[monthlyCost] => 112 Euro
[units] => 46
[pdus] => Array
(
[0] => Array
(
[lastUpdate] => 1414519287
[serialNumber] => SVNL00006722
[totalKWH] => 10239
[powerFactor] => 99.99
[ampNow] => 12.0
[ampPeak] => 22.5
[ampMax] => 31.5
[voltNow] => 235.5
[voltMin] => 228.2
[numberOfPhases] => 1
[numberOfOutlets] => 3
[feeds] => Array
(
[0] => Array
(
[outletNumber] => 1
[totalKWH] => 4242
[ampNow] => 1.20
[ampPeak] => 6.8
[voltNow] => 235.5
[voltMin] => 228.2
[powerFactor] => 99.99
)
[1] => Array
(
[outletNumber] => 2
[totalKWH] => 2102
[ampNow] => 2.30
[ampPeak] => 5.5
[voltNow] => 235.5
[voltMin] => 228.2
[powerFactor] => 99.99
)
[2] => Array
(
[outletNumber] => 3
[totalKWH] => 80
[ampNow] => 5.50
[ampPeak] => 10.2
[voltNow] => 235.5
[voltMin] => 228.2
[powerFactor] => 99.99
)
)
)
)
)
)
)
)
Request parameters
| Parameter | Context | Type | Description |
|---|---|---|---|
| colocationId | int | The ID of the colocation service |
| Parameter | Context | Type | Description |
|---|---|---|---|
| ranges | array | Your network ranges. | vlanId | ranges | int | The vlan ID | gateway | ranges | string | The gateway IP. | netmask | ranges | string | The range netmask (IPv4 only). | prefix | ranges | string | CIDR prefix, including leading slash. |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[ranges] => Array
(
[0] => Array
(
[vlanId] => 1184
[gateway] => 213.163.92.129
[netmask] => 255.255.255.224
[prefix] => /27
)
[1] => Array
(
[vlanId] => 1184
[gateway] => 2a00:1630:25::1
[prefix] => /48
)
)
)
)
Request parameters
| Parameter | Context | Type | Description |
|---|---|---|---|
| colocationId | int | The ID of the colocation service |
| 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] => 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.
)
)
)
)
Request parameters
| Parameter | Context | Type | Description |
|---|---|---|---|
| colocationId | int | The ID of the colocation service | 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 2a00:1630:2:fff::abc is now mynewptr.example.com
)
)
)
)
Request parameters
| Parameter | Context | Type | Description |
|---|---|---|---|
| colocationId | int | The ID of the colocation service | 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 2a00:1630:2:fff::abc has been removed.
)
)
)
)
Request parameters
| Parameter | Context | Type | Description |
|---|---|---|---|
| colocationId | int | The ID of the colocation service |
| Parameter | Context | Type | Description |
|---|---|---|---|
| pdus | array | List of all PDUs | lastUpdate | pdus | int | Last updated values timestamp | serialNumber | pdus | string | PDU serial number | totalKWH | pdus | int | PDU current kWh meter | powerFactor | pdus | string | PDU current power factor in percentage | ampNow | pdus | string | PDU current amperage usage | ampPeak | pdus | string | PDU highest amerage peak | ampMax | pdus | string | PDU max usable amperage | voltNow | pdus | string | PDU current voltage | voltMin | pdus | string | PDU voltage trough | numberOfPhases | pdus | int | PDU number of phases | numberOfOutlets | pdus | int | PDU number of outlets | feeds | pdus | array | List of all feeds for this PDU | outletNumber | feeds | int | Feed outlet number | totalKWH | feeds | int | Feed current kWh meter | ampNow | feeds | string | Feed current amperage usage | ampPeak | feeds | string | Feed highest amerage peak | voltNow | feeds | string | Feed current voltage | voltMin | feeds | string | Feed voltage trough | powerFactor | feeds | string | Feed current power factor in percentage |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[pdus] => Array
(
[lastUpdate] => 1414519287
[serialNumber] => SVNL00006722
[totalKWH] => 10239
[powerFactor] => 99.99
[ampNow] => 12.0
[ampPeak] => 22.5
[ampMax] => 31.5
[voltNow] => 235.5
[voltMin] => 228.2
[numberOfPhases] => 1
[numberOfOutlets] => 3
[feeds] => Array
(
[0] => Array
(
[outletNumber] => 1
[totalKWH] => 4242
[ampNow] => 1.20
[ampPeak] => 6.8
[voltNow] => 235.5
[voltMin] => 228.2
[powerFactor] => 99.99
)
[1] => Array
(
[outletNumber] => 2
[totalKWH] => 2102
[ampNow] => 2.30
[ampPeak] => 5.5
[voltNow] => 235.5
[voltMin] => 228.2
[powerFactor] => 99.99
)
[2] => Array
(
[outletNumber] => 3
[totalKWH] => 80
[ampNow] => 5.50
[ampPeak] => 10.2
[voltNow] => 235.5
[voltMin] => 228.2
[powerFactor] => 99.99
)
)
)
)
)