{
"ports": [
{
"id": 204,
"ref": "clxp-hIHFuJFl",
"name": "My DC1 Port",
"datacentre_name": "DC1-B72-1 1/3/G15",
"index": 15,
"speed": "1Gbit",
"throughput": 1000000,
"committed_bandwidth": "4Mbps",
"committed_bandwidth_raw": 4000,
"remaining_bandwidth": "996Mb/sec",
"remaining_bandwidth_raw": "999600",
"utilisation": "0.4%",
"utilisation_raw": 0.4,
"customer": "Customer name",
"customer_id": 42,
"regions": [
{
"name": "London"
},
{
"name": "UK"
},
{
"name": "Europe"
}
],
"switch": {
"id": 1,
"index": 1
},
"slot": {
"id": 3,
"index": 3
},
"shelf": {
"id": 1,
"index": 1
},
"network_alarms": [],
"services": [
{
"id": 10,
"name": "Test Service 1"
},
{
"id": 11,
"name": "Test Service 2"
}
],
"service_type": {
"id": 20,
"name": "Data Centre Interconnect",
"short_name": "INT",
"logo_path": null,
"regions": [],
"category": "INT",
"category_id": 3
},
"service_count": 2,
"single_use": 0,
"network_type": "uni",
"offnet_supplier_ref": 0,
"offnet_supplier_ref_display": false,
"offnet_service_ref": null,
"offnet_service_ref_display": false,
"user_can_access": true,
"datacentre_datacentre_name": "Epsilon Global Hubs UK",
"datacentre_logo": null,
"datacentre_city": "London",
"datacentre_city_iso": "GB",
"disabled": false,
"disabled_reason": null,
"odf_position": "NA",
"term": {
"name": "Month",
"amount": 12
},
"status": "up",
"datacentre": {
"id": 543,
"name": "Telehouse North",
"city":{
"id": 43,
"name": "London",
"country": {
"id": 3,
"name": "United Kingdom",
"continent":{
"name": "EMEA"
}
}
}
}
},
...
]
}
id
|
Description
|
The Infiny ID for the port
|
Type
|
Integer
|
Example
|
11
|
ref
|
Description
|
The Infiny port reference
|
Type
|
Text
|
Example
|
clxp-WodYttJS
|
name
|
Description
|
The friendly name for the port
|
Type
|
Text
|
Example
|
My DC Port 1
|
datacentre_name
|
Description
|
The datacentre name for the port
|
Type
|
Text
|
Example
|
EPUK-CHE2-B72-1 1/7/G5
|
index
|
Description
|
The port index on the switch
|
Type
|
Integer
|
Example
|
10
|
speed
|
Description
|
The speed of the port
|
Type
|
Text
|
Example
|
1GBit
|
throughput
|
Description
|
The throughput of the port
|
Type
|
Integer
|
Example
|
1000000
|
committed_bandwidth_raw
|
Description
|
The committed bandwidth of the port as a raw value
|
Type
|
Integer
|
Example
|
0
|
committed_bandwidth
|
Description
|
The committed bandwidth of the port
|
Type
|
String
|
Example
|
0Mb/sec
|
committed_bandwidth_raw
|
Description
|
The committed bandwidth of the port as a raw value
|
Type
|
Integer
|
Example
|
0
|
remaining_bandwidth
|
Description
|
The remaining bandwidth of the port
|
Type
|
String
|
Example
|
1,000Mb/sec
|
remaining_bandwidth_raw
|
Description
|
The remaing bandwidth of the port as a raw value
|
Type
|
Integer
|
Example
|
1000000
|
utilisation
|
Description
|
Utilisation of committed bandwidth versus throughput as a percentage
|
Type
|
String
|
Example
|
0%
|
utilisation_raw
|
Description
|
Utilisation of committed bandwidth versus throughput as a 0-100 value
|
Type
|
Integer
|
Example
|
100%
|
customer
|
Description
|
Name of customer the port is allocated to
|
Type
|
String
|
Example
|
Test Customer
|
customer_id
|
Description
|
ID of customer the port is allocated to
|
Type
|
Integer
|
Example
|
106
|
odf_position
|
Description
|
The ODF position for the port, if applicable
|
Type
|
String
|
Example
|
|
regions
|
Description
|
List of objects describing the regions a port exists in
|
Type
|
Array
|
Example
|
N/A
|
switch
|
Description
|
An object representing the switch the port is located in
|
Type
|
Object
|
Example
|
N/A
|
slot
|
Description
|
An object representing the slot the port is located in
|
Type
|
Object
|
Example
|
N/A
|
shelf
|
Description
|
An object representing the shelf the port is located in
|
Type
|
Object
|
Example
|
N/A
|
shelf_type
|
Description
|
Name of the shelf type
|
Type
|
String
|
Example
|
PVX
|
network_alarms
|
Description
|
List of objects describing the network alarms on the port
|
Type
|
Array
|
Example
|
N/A
|
services
|
Description
|
List of objects describing the services on the port
|
Type
|
Array
|
Example
|
N/A
|
service_type
|
Description
|
Object describing the type of service the port supports
|
Type
|
Object
|
Example
|
N/A
|
service_count
|
Description
|
Count of the number of services on the port
|
Type
|
Integer
|
Example
|
N/A
|
single_use
|
Description
|
Boolean indicator for whether the port is for single or multiple use
|
Type
|
Boolean Integer
|
Example
|
0
|
network_type
|
Description
|
Value determine the ports network type, either UNI or ENNI. If not provide, UNI will be assumed.
|
Enum(String) [uni|enni]
|
uni
|
Example
|
0
|
offnet_supplier_ref
|
Description
|
Reference of the port offnet supplier
|
Type
|
String
|
Example
|
Offnet test
|
offnet_supplier_ref_display
|
Description
|
Display name of the port offnet supplier
|
Type
|
String
|
Example
|
|
offnet_service_ref
|
Description
|
Reference of the port offnet supplier service
|
Type
|
String
|
Example
|
123456
|
offnet_service_ref_display
|
Description
|
Display name of the port offnet supplier service
|
Type
|
String
|
Example
|
|
user_can_access
|
Description
|
Boolean indicator if the port is accessible to the authenticated user
|
Type
|
Boolean
|
Example
|
true
|
datacentre_datacentre_name
|
Description
|
Friendly name of the datacentre the port exists in
|
Type
|
String
|
Example
|
Digital Realty Trust, Digital Chessington
|
datacentre_logo
|
Description
|
Image file of the logo for the datacentre the port exists in
|
Type
|
File
|
Example
|
N/A
|
datacentre_city
|
Description
|
Name of the town of the datacentre the port exists in
|
Type
|
String
|
Example
|
"London"
|
datacentre_city_iso
|
Description
|
ISO2 country code of the country of the datacentre the port exists in
|
Type
|
String
|
Example
|
"GB"
|
price
|
Description
|
The price of the current contract.
|
Type
|
Object[String]
|
Example
|
See example above
|
price_currency
|
Description
|
The currency of the price property
|
Type
|
String
|
Example
|
GBP
|
term
|
Description
|
The term of the contract
|
Type
|
Object[String]
|
Example
|
See example above
|
cable_price
|
Description
|
The price of the current cable contract.
|
Type
|
Object[String]
|
Example
|
See example above
|
cable_price_currency
|
Description
|
The currency of the cable_price property
|
Type
|
String
|
Example
|
GBP
|
cable_term
|
Description
|
The term of the cable contract
|
Type
|
Object[String]
|
Example
|
See example above
|
order_date
|
Description
|
The date that the order was placed (UTC).
|
Type
|
String
|
Example
|
2021-05-02 15:14:59
|
activation_date
|
Description
|
The date that the port was activated (UTC).
|
Type
|
String
|
Example
|
2021-05-03 07:33:41
|
statistics
|
Description
|
An object representing the current statistics on the port
|
Type
|
Object
|
rx
|
Description
|
The current RX values for the port
|
Type
|
Object
|
Example
|
"rx": {
"name": "RX",
"lastvalue": "106 Mb/s",
"lastvalue_raw": 132155990.4
}
|
tx
|
Description
|
The current TX values for the port
|
Type
|
Object
|
Example
|
"tx": {
"name": "TX",
"lastvalue": "106 Mb/s",
"lastvalue_raw": 132155740.0333
}
|
services
|
Description
|
An array of service objects attached to the port
|
Type
|
Array
|
datacentre
|
Description
|
The datacentre the port is located in
|
Type
|
Object
|
Example
|
See object definition on the Datacentre Locality API page
|