Metros

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.

Request
path Parameters
username
required
string

The username of the company you are checking.

Example: consoleconnect
query Parameters
hasPort
boolean

When true, only shows Metros the specified company has Ports in.

Example: hasPort=true
header Parameters
portal-token
required
string

Authentication token.

Responses
200

OK

get/api/company/{username}/metro
Response samples
application/json
{
  • "results": [
    ]
}

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.

Request
path Parameters
username
required
string

The username of the Company to query.

Example: consoleconnect
header Parameters
portal-token
required
string

Authentication token.

Responses
200

OK

get/api/company/{username}/metro/capabilities
Response samples
application/json
{
  • "results": [
    ]
}

Get Metro by ID

Returns the basic information for a Metro.

Request
path Parameters
metroId
required
string

Metro ObjectId

Example: 235014958511023495968818
header Parameters
portal-token
required
string

Authentication token.

Responses
200

OK

404

Not Found

get/api/metro/{metroId}
Response samples
application/json
{
  • "results": [ ],
  • "controllers": [ ],
  • "metro": {
    },
  • "ports": { },
  • "asns": { }
}