Data Center Facilities (DCFs)

Data Center Facilities (DCFs) are the hosts of Ports on the Console Connect platform. They support a range of Speeds (1Gb, 10Gb, 1000Gb) in various locations across the globe. The endpoints and examples listed in this section will help you find the right DCF for your needs.

Get DCF locations

Before diving directly into finding DCFs, it is helpful to know which locations are available to order Ports from. This endpoint returns a list of country and city pairs that can be used in search.

The criteria of the list is based on the following:

  • A DCF is ready for ordering Ports from: dataCenterFacility.ready
Responses
200

Returns a list of locations with available DCFs

get/v2/data-center-facilities/locations
Response samples
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Get Cloud DCF locations

This endpoint is much like finding general DCF locations, only it narrows down the criteria even further by returning only the locations that our Cloud partners have available ports in. This endpoint is useful when you want to find DCFs to create a Layer 2 Connection to a Cloud provider (e.g. AWS).

Responses
200

Returns a list of DCFs available from Clouds.

get/v2/data-center-facilities/cloud-locations
Response samples
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Search DCFs

Search for available DCFs on and off the network.

To ensure a DCF is ready for physical port orders, ensure the property dataCenterFacility.ready: true is set when searching for DCFs. To find a DCF that supports Hybrid NNI Ports, search for dataCenterFacility.nniReady: true.

See the Query Parameters section below for search examples.

Request
query Parameters
required
object (LoopBackFilter)

Criteria for searching DCFs.

Examples:
filter={ "where": { "dataCenterFacility.speeds.value": 10000, "dataCenterFacility.ready": true }, "skip": 0, "limit": 10 }
filter={ "where": { "company.addresses.country": "AU", "company.addresses.city": "Sydney" "dataCenterFacility.speeds.value": 10000, "dataCenterFacility.ready": true }, "skip": 0, "limit": 10 }
filter={ "where": { "name": { "like": "DCF Name", options: "i" }, }, "skip": 0, "limit": 10 }
Responses
200

returns a list of DCFs or an empty array

get/v2/data-center-facilities
Response samples
application/json
[
  • {
    }
]

Get DCF by ID

Get a single DCF by its ID.

Request
path Parameters
id
required
string

The ObjectId of the DCF.

Example: 507f1f77bcf86cd799439011
Responses
200

Returns a single DCF.

404

Throws an error for an invalid DCF.

get/v2/data-center-facilities/{id}
Response samples
application/json
{
  • "id": "507f1f77bcf86cd799439011",
  • "name": "PCCW Global - Hermes House",
  • "username": "pccwg-hermes-house",
  • "company": {
    },
  • "dataCenterFacility": {
    }
}