1. Ports
  3. API Documentation
  4. Get Available Ports

Get ports available for purchase

Get a list of available ports for purchase.

Request

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

Optional GET request parameters

datacentre_id Description The ID of the datacentre where the ports are located. datacentre_id provided in the Datacentre Locality API
Type Integer
Example 15
city_id Description The ID of the city where the ports are located. city_id provided in the Cities Locality API
Type Integer
Example 142
continent_id Description The ID of the continent where the ports are located. continent_id provided in the Continents Locality API
Type Integer
Example 3
can_enni Description Boolean value determining that the port can be used as an ENNI if desired.
Type Integer [1|0]
Example 1

Response

Example:

                                
{
    "ports": [
        {
            "id": 12345,
            "type": "1Gbit",
            "prices": [
                {
                    "term": {
                        "name": "Month",
                        "amount": 12
                    },
                    "cost": {
                        "mrc": 100,
                        "nrc": null,
                        "arc": null,
                        "src": null
                    }
                }
            ],
            "cable_prices": [
                {
                    "term": {
                        "name": "Month",
                        "amount": 12
                    },
                    "cost": {
                        "mrc": 25,
                        "nrc": 125,
                        "arc": null,
                        "src": null
                    }
                }
            ],
            "currency": "GBP",
            "datacentre": {
                "id": 543,
                "name": "Telehouse North",
                "city":{
                    "id": 43,
                    "name": "London",
                    "country": {
                        "id": 3,
                        "name": "United Kingdom",
                        "continent":{
                            "name": "EMEA"
                        }
                    }
                }
            },
            "cross_connected": false,
            "can_enni": true,
        },
        ...
}
id Description The ID of the port.
Type Integer
Example 12345
type Description The type (capacity) of the port
Type String
Example 1Gbit
prices Description The list of port pricing
Type Array[Objects]
Example See example above
cable_prices Description The list of port cabling pricing
Type Array[Objects]
Example See example above
currency Description The ISO code for the currency relating to the associated price field
Type String
Example GBP
datacentre Description Object describing the Datacentre where the port is located
Type Object
Example Object definitions can be found on the Datacentre Locality API page
cross_connected Description Whether the port is available via a cross-connection.
Type Boolean
Example Object definitions can be found on the Datacentre Locality API page

Back to top