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

Securityapi-key

Responses

200

Returns a list of locations with available DCFs

get/v2/data-center-facility/locations

Response samples

application/json

[{"country": "AU,",
"city": "Brisbane"
},
{"country": "US,",
"city": "New York"
},
{"country": "JP,",
"city": "Tokyo"
}
]

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).

Securityapi-key

Responses

200

Returns a list of DCFs available from Clouds.

get/v2/data-center-facility/cloud-locations

Response samples

application/json

[{"country": "AU,",
"city": "Brisbane"
},
{"country": "US,",
"city": "New York"
},
{"country": "JP,",
"city": "Tokyo"
}
]

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.

Securityapi-key

Request

query Parameters

required

object (LoopBackFilter)

Criteria for searching DCFs.

Examples:

Search DCFs by Speed. Value in Mbps. filter={ "where": { "dataCenterFacility.speeds.value": 10000, "dataCenterFacility.ready": true }, "skip": 0, "limit": 10 }

Search DCFs by Location. filter={ "where": { "company.addresses.country": "AU", "company.addresses.city": "Sydney" "dataCenterFacility.speeds.value": 10000, "dataCenterFacility.ready": true }, "skip": 0, "limit": 10 }

Search DCFs by Name. filter={ "where": { "name": {"like": "DCF Name", "options": "i"}, "dataCenterFacility.ready": true }, "skip": 0, "limit": 10 }

Search DCFs by CrossConnect Add On. filter={ "where": { "dataCenterFacility.canBundleCrossConnect": true, "dataCenterFacility.ready": true }, "skip": 0, "limit": 10 }

Search DCFs by Free CrossConnect. filter={ "where": { "tags": {"in": ["free-cross-connect"]}, "dataCenterFacility.ready": true }, "skip": 0, "limit": 10 }

Search DCFs by Extended (Off-Net). filter={ "where": { "tags": {"in": "offnet"}, "dataCenterFacility.ready": true }, "skip": 0, "limit": 10 }

Search DCFs by On-Net. filter={ "where": { "tags": {"nin": "offnet"}, "dataCenterFacility.ready": true }, "skip": 0, "limit": 10 }

Search DCFs that accept month-to-month port orders. filter={ "where": { "tags": {"in": "monthly-ports"}, "dataCenterFacility.ready": true }, "skip": 0, "limit": 10 }

Responses

200

returns a list of DCFs or an empty array

get/v2/data-center-facility

Response samples

application/json

[{"id": "507f1f77bcf86cd799439011",
"name": "Console Connect - Hermes House",
"username": "pccwg-hermes-house",
"company": {"addresses": [{"street": "5/F, Hermes House,10 Middle Road,Tsim Sha Tsui",
"city": "Hong Kong",
"country": "CN"
}
]
},
"dataCenterFacility": {"metroId": "507f1f77bcf86cd799439011",
"ready": true,
"nniReady": true,
"speeds": [{"name": "10000 Mbps",
"value": 10000
}
],
"canBundleCrossConnect": false
}
}
]

Search DCFs by criteria

Search for available DCFs on and off the network. See the Query Parameters section below for search examples.

Securityapi-key

Request

query Parameters

required	object Criteria for searching DCFs. Examples: Search DCFs by Speed. Value in Mbps. criteria={ "speeds": [1000] } Search DCFs by Location. criteria={ "locations": ["Sydney,AU"], "speeds": [10000] } Search DCFs by Name. criteria={ "name": "DCF Name" } Search DCFs by CrossConnect Add On. criteria={ "crossConnect": ["addOn"] } Search DCFs by Free CrossConnect. criteria={ "crossConnect": ["free"] } Search DCFs by Extended (Off-Net). criteria={ networkStatus: ['offNet'] } Search DCFs by On-Net. criteria={ networkStatus: ['onNet'] }
page	integer the page number of the results Example: page=1
pageSize	integer the number of results per page Example: pageSize=10

Responses

200

returns a list of DCFs or an empty array

get/v2/data-center-facility/search

Response samples

application/json

[{"id": "507f1f77bcf86cd799439011",
"name": "Console Connect - Hermes House",
"username": "pccwg-hermes-house",
"company": {"addresses": [{"street": "5/F, Hermes House,10 Middle Road,Tsim Sha Tsui",
"city": "Hong Kong",
"country": "CN"
}
]
},
"dataCenterFacility": {"metroId": "507f1f77bcf86cd799439011",
"ready": true,
"nniReady": true,
"speeds": [{"name": "10000 Mbps",
"value": 10000
}
],
"canBundleCrossConnect": false
}
}
]

Get DCF by ID

Get a single DCF by its ID.

Securityapi-key

Request

path Parameters

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-facility/{id}

Response samples

application/json

{"id": "507f1f77bcf86cd799439011",
"name": "Console Connect - Hermes House",
"username": "pccwg-hermes-house",
"company": {"addresses": [{"street": "5/F, Hermes House,10 Middle Road,Tsim Sha Tsui",
"city": "Hong Kong",
"country": "CN"
}
]
},
"dataCenterFacility": {"metroId": "507f1f77bcf86cd799439011",
"ready": true,
"nniReady": true,
"speeds": [{"name": "10000 Mbps",
"value": 10000
}
],
"canBundleCrossConnect": true
},
"bundleCrossConnectChargeId": "65eff1e96d38598ce3cf6247"
}

➔ Next to Port Orders