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
| 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] => _ID_
[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] => _SERIAL_
[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
)
)
)
)
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| colocationId | int | The ID of the colocation service | 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 |
|---|---|---|---|
| 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] => _ID_
[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] => _SERIAL_
[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
)
)
)
)
)
)
)
)
| 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] => 203.0.113.2
[netmask] => 255.255.255.224
[prefix] => /27
)
[1] => Array
(
[vlanId] => 1184
[gateway] => 2001:db8::13::48
[prefix] => /48
)
)
)
)
| 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] => 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 |
|---|---|---|---|
| colocationId | int | The ID of the colocation service | records | array array | Array containing records, each containing an ip and ptr key value pair | ip | records | string | An IP address | ptr | records | string | 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 |
|---|---|---|---|
| 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 2001:db8::13::48 has been removed.
)
)
)
)
| 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] => _SERIAL_
[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
)
)
)
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| No parameters | |||
| Parameter | Context | Type | Description |
|---|---|---|---|
| userId | int | userId of the whitelist entry | whitelistId | int | The whitelistId for this entry | dateverified | date | The date this entry was verified | dateonlist | date | The date this entry was added | dateofflist | date | The date this entry was removed | datevisit | date | The date of last visit | timevisit | time | The time of last visit | string | The email address for this user | mobile | string | The mobile phone number for this user | firstName | string | The first name of this user | lastName | string | The last name of this user | birthDate | date | The date of birth for this user | companyName | string | The company name at which this user is employed | companyFunction | string | The function this user has at it`s company | city | string | The city in which this user lives | country | int | The countryId for the country in which this user lives | countryEN | string | The English notation of the country this user lives in | countryNL | string | The Dutch notation of the country this user lives in | licensePlate | string | The licenseplate for this user | licensePlateCountryId | int | The countryId for the country this licenseplate is for | licensePlateCountryCode | string | The two letter countrycode for this licenseplate | userDocuments | array | Array with all the documents for this user | whitelistColocatedServers | array | Array with all the colocation servers this entry has access for | createdBy | int | The userId of the user that created this entry |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[userId] => _USER-ID_
[whitelistId] => 123
[dateverified] => 2015-07-15
[dateonlist] => 2015-07-07
[dateofflist] => 0000-00-00
[datevisit] => 2015-07-18
[timevisit] => 12:14:40
[email] => john@example.com
[mobile] => 06-123456789
[firstName] => John
[lastName] => Doe
[birthDate] => 1970-01-01
[companyName] => i3D.net
[companyFunction] => Employee
[city] => Rotterdam
[country] => 149
[countryEN] => Netherlands
[countryNL] => Nederland
[licensePlate] => 12-12-12
[licensePlateCountryId] => 149
[licensePlateCountryCode] => NL
[documents] => Array
(
[456] => Array
(
[documentId] => 456
[documentType] => 2
[documentNumber] => 123456789ABC
[documentExpiration] => 2020-12-12
[documentNameEnglish] => Drivers license
[documentNameDutch] => Rijbewijs
)
)
[colocatedServers] => Array
(
[123] => Array
(
[coloId] => 123
[rackName] => Suite XX - Rack XX
)
)
[createdBy] => 123456
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| whitelistId | int | The whitelistId of the desired entry |
| Parameter | Context | Type | Description |
|---|---|---|---|
| userId | int | userId of the whitelist entry | whitelistId | int | The whitelistId for this entry | dateverified | date | The date this entry was verified | dateonlist | date | The date this entry was added | dateofflist | date | The date this entry was removed | datevisit | date | The date of last visit | timevisit | time | The time of last visit | string | The email address for this user | mobile | string | The mobile phone number for this user | firstName | string | The first name of this user | lastName | string | The last name of this user | birthDate | date | The date of birth for this user | companyName | string | The company name at which this user is employed | companyFunction | string | The function this user has at it`s company | city | string | The city in which this user lives | country | int | The countryId for the country in which this user lives | countryEN | string | The English notation of the country this user lives in | countryNL | string | The Dutch notation of the country this user lives in | licensePlate | string | The licenseplate for this user | licensePlateCountryId | int | The countryId for the country this licenseplate is for | licensePlateCountryCode | string | The two letter countrycode for this licenseplate | userDocuments | array | Array with all the documents for this user | whitelistColocatedServers | array | Array with all the colocation servers this entry has access for | createdBy | int | The userId of the user that created this entry |
Example
Array
(
[status] => Success
[msg] => OK
[data] => stdClass Object
(
[userId] => _USER-ID_
[whitelistId] => 123
[dateverified] => 2015-07-15
[dateonlist] => 2015-07-07
[dateofflist] => 0000-00-00
[datevisit] => 2015-07-18
[timevisit] => 12:14:40
[email] => john@example.com
[mobile] => 06-123456789
[firstName] => John
[lastName] => Doe
[birthDate] => 1970-01-01
[companyName] => i3D.net
[companyFunction] => Employee
[city] => Rotterdam
[country] => 149
[countryEN] => Netherlands
[countryNL] => Nederland
[licensePlate] => 12-12-12
[licensePlateCountryId] => 149
[licensePlateCountryCode] => NL
[documents] => Array
(
[456] => Array
(
[documentId] => 456
[documentType] => 2
[documentNumber] => 123456789ABC
[documentExpiration] => 2020-12-12
[documentNameEnglish] => Drivers license
[documentNameDutch] => Rijbewijs
)
)
[colocatedServers] => Array
(
[123] => Array
(
[coloId] => 123
[rackName] => Suite XX - Rack XX
)
)
[createdBy] => 123456
)
)
| Parameter | Context | Type | Description |
|---|---|---|---|
| REQUIRED | string | The email for this person. | firstName | REQUIRED | string | The first name for this person. | lastName | REQUIRED | string | The last name for this person. | birthDate | REQUIRED | date | The date of birth for this person. | mobile | string | The mobile number for this person. | companyName | string | The company name this person works at. | companyFunction | string | The function within the company for this person. | City | string | The city this person lives. | Country | string | The country(2 letter code) this person lives. | licensePlate | string | The license plate for this person`s car. | licensePlateCountry | string | The license plate country for this person`s car. | document | array | All the documents for this person which will be used for identification. | access | array | All the coloId this person will have access to. |
| Parameter | Context | Type | Description |
|---|---|---|---|
| whitelistId | int | The whitelistId of the new entry |
Example
Request_Example :
Array ( [email] => john@example.com [mobile] => 06-123456789 [firstName] => John [lastName] => Doe [birthDate] => 1970-01-01 [companyName] => i3D.net [companyFunction] => Employee [city] => Rotterdam [country] => NL [licensePlate] => 12-12-12 [licensePlateCountry] => NL [document] => Array ( [0] => Array ( [documentType] => 2 // types: 1=Unknown 2=Drivers License 3=Passport 4=Identity Card [documentNumber] => 123456789ABC [documentExpiration] => 2020-12-12 ) ) [access] => Array ( [123] => Array ( [coloId] => 123 ) [456] => Array ( [coloId] => 456 ) ) )
| Parameter | Context | Type | Description |
|---|---|---|---|
| whitelistId | REQUIRED | int | The whitelistId for this entry. | REQUIRED | string | The email for this person. | firstName | REQUIRED | string | The first name for this person. | lastName | REQUIRED | string | The last name for this person. | birthDate | REQUIRED | date | The date of birth for this person. | mobile | string | The mobile number for this person. | companyName | string | The company name this person works at. | companyFunction | string | The function within the company for this person. | City | string | The city this person lives. | Country | string | The country(2 letter code) this person lives. | licensePlate | string | The license plate for this person`s car. | licensePlateCountry | string | The license plate country for this person`s car. | document | array | All the documents for this person which will be used for identification. | access | array | All the coloId this person will have access to. |
| Parameter | Context | Type | Description |
|---|---|---|---|
| response | string | Succeeded or failed |
Example
Request_Example :
Array ( [whitelistId] => 123 [email] => john@example.com [firstName] => John [lastName] => Doe [birthDate] => 1970-01-01 [mobile] => 06-123456789 [companyName] => i3D.net [companyFunction] => Employee [city] => Rotterdam [country] => NL [licensePlate] => 12-12-12 [licensePlateCountry] => NL [document] => Array ( [0] => Array ( [documentType] => 2 // types: 1=Unknown 2=Drivers License 3=Passport 4=Identity Card [documentNumber] => 123456789ABC [documentExpiration] => 2020-12-12 ) ) [access] => Array ( [123] => Array ( [coloId] => 123 ) [456] => Array ( [coloId] => 456 ) ) )
| Parameter | Context | Type | Description |
|---|---|---|---|
| whitelistId | int | The whitelistId for this entry. |
| Parameter | Context | Type | Description |
|---|---|---|---|
| response | string | true, false or already completed |
| Parameter | Context | Type | Description |
|---|---|---|---|
| whitelistId | int | The whitelistId for this entry. |
| Parameter | Context | Type | Description |
|---|---|---|---|
| response | string | true, false or already completed |
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 |
|---|---|---|---|
| colocationId | int | The ID of the colocation server | incGraph | int | (optional) Include graph image data if 1 | 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 | int | Incoming traffic for that day. | out | linkName | int | 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 |
|---|---|---|---|
| colocationId | int | The ID of the colocation server | 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 (png)
[graphWeek] => base64encoded image data (png)
[graphMonth] => base64encoded image data (png)
[graphYear] => base64encoded image data (png)
)
)
)
)