Metros are the locations of DCFs on the Console Connect platform. These endpoints can be used to search for places where companies have active ports available for Layer 2 Connections.
List Metro Count for a Company
This endpoint is used to list the Metros a given Company is present at, usually with Ports.
Securityapi-key
Request
Responses
200
OK
get/api/company/{username}/metro
Response samples
- 200
application/json
{- "results": [
- {
- "city": "London",
- "count": 20,
- "country": "UK",
- "name": "London, UK"
}
]
}List Metros for a Company
Returns a list of Metros a given Company has a presence at. This is typically in the form of Port.
Securityapi-key
Request
Responses
200
OK
get/api/company/{username}/metro/capabilities
Response samples
- 200
application/json
{- "results": [
- {
- "capabilities": {
- "layer2": true,
- "layer3": true
}, - "code": "BNE",
- "country": "AU",
- "description": "Brisbane city metro.",
- "id": "d466b388d3e9ee0a92177910",
- "name": "Brisbane",
- "ready": true,
- "regionIds": [
- "236107000000000000000001"
], - "createdAt": "2016-02-12T09:01:00.000Z",
- "updatedAt": "2016-02-12T09:01:00.000Z",
- "firstDataCenterFacilityId": "5af90d4548ba7200120a194b"
}
]
}Get Metro by ID
Returns the basic information for a Metro.
Securityapi-key
Responses
200
OK
404
Not Found
get/api/metro/{metroId}
Response samples
- 200
- 404
application/json
{- "results": [ ],
- "controllers": [ ],
- "metro": {
- "id": "77d9f1fbbcaa906f3cddb6d1",
- "name": "Brisbane",
- "code": "BNE",
- "description": "Brisbane metro area.",
- "ready": true,
- "country": "AU",
- "rir": "APNIC",
- "regionIds": [
- "5b7f5dd15acc27000a7acdf9"
], - "updatedAt": "2020-08-18T04:08:43.554Z",
- "createdAt": "2017-12-18T00:45:44.120Z",
- "deleted": false,
- "deletedAt": null
}, - "ports": { },
- "asns": { }
}