List details of a port

List details of a port using the CloudLX port ID.

Request

Endpoint: /api/ports/<port_id>/port
Method: GET
Headers: Accept: application/vnd.cloudlx.v1+json
Authorization: Bearer <access_token>

Response

Example:

                                {
    "id": 11,
    "ref": "clxp-WodYttJS",
    "name": "CHE2-B72-1 1/7/G5",
    "datacentre_name": "EPUK-CHE2-B72-1 1/7/G5",
    "index": 5,
    "speed": "1Gbit",
    "throughput": 1000000,
    "committed_bandwidth": "0Mb/sec",
    "committed_bandwidth_raw": 0,
    "remaining_bandwidth": "1,000Mb/sec",
    "remaining_bandwidth_raw": 1000000,
    "utilisation": "0%",
    "utilisation_raw": "0",
    "customer": "Test Customer",
    "customer_id": 106,
    "odf_position": "",
    "regions": [
        {
            "name": "London"
        },
        {
            "name": "United Kingdom"
        },
        {
            "name": "Europe"
        }
    ],
    "switch": {
        "index": 1
    },
    "slot": {
        "index": 7
    },
    "shelf": {
        "index": 1,
        "name": "EPUK-CHE2-B72-1"
    },
    "shelf_type": "PVX",
    "network_alarms": [
        {
            "description": "Loss of signal.",
            "created_at": "2018-04-15T01:10:52+00:00"
        },
        {
            "description": "Loss of signal.",
            "created_at": "2017-11-18T03:16:54+00:00"
        },
        {
            "description": "Loss of signal.",
            "created_at": "2017-04-29T18:47:06+00:00"
        }
    ],
    "services": [],
    "service_type": {
        "id": 20,
        "name": "Inter-port Connection",
        "short_name": "INT",
        "logo_path": null,
        "regions": "",
        "category": "INT",
        "category_id": 3
    },
    "service_count": 0,
    "single_use": 0,
    "offnet_supplier_ref": "Offnet test",
    "offnet_supplier_ref_display": null,
    "offnet_service_ref": "123456",
    "offnet_service_ref_display": null,
    "service_town": null,
    "user_can_access": true,
    "datacentre_datacentre_name": "Digital Realty Trust, Digital Chessington",
    "datacentre_logo": "/clx/datacentre-groups/6/datacentre-group/logo?realm=clx?_1529671900",
    "datacentre_city": "London",
    "datacentre_city_iso": "GB",
    "status": "down",
    "statistics": [],
    "datacentre": {
        "id": 543,
        "name": "Telehouse North",
        "city":{
            "id": 43,
            "name": "London",
            "country": {
                "id": 3,
                "name": "United Kingdom",
                "continent":{
                    "name": "EMEA"
                }
            }
        }
    }
}
                                
                            
id Description The CloudLX ID for the port
Type Integer
Example 11
ref Description The CloudLX 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
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
service_town Description Name of the service town
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"
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

Back to top