Metros

Get All Metros

GET /fabric/v4/metros
Method GET
URL or Endpoint /fabric/v4/metros
Headers Content-Type, Authorization
Path Parameters Not applicable
Query Parameters offset, limit, presence
Body Parameters Not applicable

The GET Metros API request retrieves metros where Equinix Fabric is available. Returned data set includes connection latency information for each location. This performance data helps network planning engineers and administrators make strategic decisions about port locations and traffic routes.

To learn how to obtain an authorization token, see Requesting Access and Refresh Tokens under the Getting Access Token section.


Sample curl request - get all metros with user-provisioned ports

Copy 
curl -X GET 'https://api.equinix.com/fabric/v4/metros?presence=MY_PORTS'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer qwErtY8zyW1abcdefGHI'

Query parameters

Parameter
Description
offset integer
OPTIONAL		 Index of the first item returned in the response.
Minimum: 0
Default value: 0
limit integer
OPTIONAL		 Maximum number of items returned per page.
Minimum: 1
Maximum: 100
Default value: 10
presence string
OPTIONAL		 Returns all metros with user-provisioned Fabric ports.
Applicable values:
  • MY_PORTS

Response body

Copy 
{
    "pagination": {
        "offset": 0,
        "limit": 75,
        "total": 12
    },
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/metros/AM",
            "type": "XF_METRO",
            "code": "AM",
            "name": "Amsterdam",
            "region": "EMEA",
            "localVCBandwidthMax": 10000,
            "geoScopes": [],
            "connectedMetros": [
                {
                    "href": "https://api.equinix.com/fabric/v4/metros/MX",
                    "code": "MX",
                    "avgLatency": 133,
                    "remoteVCBandwidthMax": 10000
                },
                {
                    "href": "https://api.equinix.com/fabric/v4/metros/HH",
                    "code": "HH",
                    "avgLatency": 8.65,
                    "remoteVCBandwidthMax": 10000
                },
                {
                    "href": "https://api.equinix.com/fabric/v4/metros/SL",
                    "code": "SL",
                    "avgLatency": 230,
                    "remoteVCBandwidthMax": 25000
                },
                {
                    "href": "https://api.equinix.com/fabric/v4/metros/SO",
                    "code": "SO",
                    "avgLatency": 36.5,
                    "remoteVCBandwidthMax": 50000
                }
            ]
        }
    ]
}

Response payload body description

Parameter
Description
pagination object
 Search results pagination settings.
offset integer
 Index of the first item returned in the response.
Example: 20
limit integer
 Maximum number of items returned per page.
Example: 20
total integer
 Total number of items returned.
Example: 1
data array[object]
 Data array containing search results.
href string
 Absolute URL that returns the specified entity.
Example:https://api.equinix.com/fabric/v4/metros/AM
type string
 Metro type.
Example: XF_METRO - Metro in which Equinix Fabric is available.
code string
 Metropolitan area identifier.
Example: AM
name string
 Name of the city in which the data center is located.
Example: Amsterdam
region string
 Broad geographic area in which the data center is located.
  • EMEA - comprises Abhu Dhabi (AD), Amsterdam (AM), Barcelona (BA), Dubai (DX), Dublin (DB), Dusseldorf (DU), Enschede (EN), Frankfurt (FR), Geneva (GV), Hamburg (HH), Helsinki (HE), Istanbul (IL), Lisbon (LS), London (LD), Madrid (MD), Manchester (MA), Milan (ML), Munich (MU), Muscat (MC), Paris (PA), Seville (SA), Sofia (SO), Stockholm (SK), Warsaw (WA), Zurich (ZH), and Zwolle (ZW).
  • AMER - comprises Atlanta (AT), Bogota (BG), Boston (BO), Chicago (CH), Culpepper (CU), Dallas (DA), Denver (DE), Houston (HO), Los Angeles (LA), Mexico City (MX), Miami (MI), Monterrey (MO), Montreal (MT), New York (NY), Philadelphia (PH), Rio de Janeiro (RJ), Sao Paulo (SP), Seattle (SE), Silicon Valley (SV), Toronto (TR), and Washington, DC [Ashburn] (DC).
  • APAC - comprises Adelaide (AE), Brisbane (BR), Canberra (CA), Hongkong (HK), Jakarta (JK), Melbourne (ME), Osaka (OS), Perth (PE), Seoul (SL), Shanghai (SH), Singapore (SG), Sydney (SY), and Tokyo (TY)
localVCBandwidthMax integer
 This is the max bandwidth for a local virtual connection.
Example: 10000
geoScopes array[string]
 A list of boundaries within which the connection traffic can be constrained.
Example: ["CONUS"]
connectedMetros array[object]
 Array of objects with connection latency data for the specified metros.
href string
 Absolute URL that returns the specified entity.
Example:https://api.equinix.com/fabric/v4/metros/MX
code string
 Metropolitan area identifier.
Example: MX
avgLatency integer
 Average monthly connection latency in ms.
Example: 133
remoteVCBandwidthMax integer
 Max bandwidth for the remote connection.
Example: 50000

If you get an "Access Denied" error, please contact your local Equinix Service Desk for help.

Get Metros by Metro Code

GET /fabric/v4/metros/{metroCode}
Method GET
URL or Endpoint /fabric/v4/metros
Headers Content-Type, Authorization
Path Parameters metroCode
Query Parameters Not applicable
Body Parameters Not applicable

This API request retrieves a specified metro. Returned data set includes connection latency information for each location. This performance data helps network planning engineers and administrators make strategic decisions about port locations and traffic routes.

To learn how to obtain an authorization token, see Requesting Access and Refresh Tokens under the Getting Access Token section.


Sample cURL request

Copy 
curl -X GET 'https://api.equinix.com/fabric/v4/metros/AM'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
metroCode string
REQUIRED		 Metropolitan area identifier.
Applicable values:
EMEA
  • AD - Abhu Dhabi
  • AM - Amsterdam
  • BA - Barcelona
  • DX - Dubai
  • DB - Dublin
  • DU - Dusseldorf
  • EN - Enschede
  • FR - Frankfurt
  • GV - Geneva
  • HH - Hamburg
  • HE - Helsinki
  • IL - Istanbul
  • LS - Lisbon
  • LD - London
  • MD - Madrid
  • MA - Manchester
  • ML - Milan
  • MU - Munich
  • MC - Muscat
  • PA - Paris
  • SA - Seville
  • SO - Sofia
  • SK - Stockholm
  • WA - Warsaw
  • ZH - Zurich
  • ZW - Zwolle
AMER
  • AT - Atlanta
  • BG - Bogota
  • BO - Boston
  • CH - Chicago
  • CU - Culpepper
  • DA - Dallas
  • DE - Denver
  • HO - Houston
  • LA - Los Angeles
  • MX - Mexico City
  • MI - Miami
  • MO - Monterrey
  • MT - Montreal
  • NY - New York
  • PH - Philadelphia
  • RJ - Rio de Janeiro
  • SP - Sao Paulo
  • SE - Seattle
  • SV - Silicon Valley
  • TR - Toronto
  • DC - Washington, DC [Ashburn].
APAC
  • AE - Adelaide
  • BR - Brisbane
  • CA - Canberra
  • HK - Hongkong
  • JK - Jakarta
  • ME - Melbourne
  • OS - Osaka
  • PerthPE -
  • SL - Seoul
  • SH - Shanghai
  • SG - Singapore
  • SY - Sydney
  • TY Tokyo

Response body

Copy 
{
    "href": "https://api.equinix.com/fabric/v4/metros/AT",
    "type": "XF_METRO",
    "code": "AT",
    "name": "Atlanta",
    "region": "EMEA",
    "localVCBandwidthMax": 10000,
    "geoScopes": [],
    "connectedMetros": [
        {
            "href": "https://api.equinix.com/fabric/v4/metros/LD",
            "code": "LD",
            "avgLatency": 100,
            "remoteVCBandwidthMax": 10000
        },
        {
            "href": "https://api.equinix.com/fabric/v4/metros/SV",
            "code": "SV",
            "avgLatency": 150,
            "remoteVCBandwidthMax": 25000
        }
    ]
}

Response payload body description

Parameter
Description
href string
 Absolute URL that returns the specified entity.
Example:https://api.equinix.com/fabric/v4/metros/AM
type string
 Metro type.
Example: XF_METRO - Metro in which Equinix Fabric is available.
code string
 Metropolitan area identifier.
Example: AM
name string
 Name of the city in which the data center is located.
Example: Amsterdam
region string
 Broad geographic area in which the data center is located.
  • EMEA - comprises Abhu Dhabi (AD), Amsterdam (AM), Barcelona (BA), Dubai (DX), Dublin (DB), Dusseldorf (DU), Enschede (EN), Frankfurt (FR), Geneva (GV), Hamburg (HH), Helsinki (HE), Istanbul (IL), Lisbon (LS), London (LD), Madrid (MD), Manchester (MA), Milan (ML), Munich (MU), Muscat (MC), Paris (PA), Seville (SA), Sofia (SO), Stockholm (SK), Warsaw (WA), Zurich (ZH), and Zwolle (ZW).
  • AMER - comprises Atlanta (AT), Bogota (BG), Boston (BO), Chicago (CH), Culpepper (CU), Dallas (DA), Denver (DE), Houston (HO), Los Angeles (LA), Mexico City (MX), Miami (MI), Monterrey (MO), Montreal (MT), New York (NY), Philadelphia (PH), Rio de Janeiro (RJ), Sao Paulo (SP), Seattle (SE), Silicon Valley (SV), Toronto (TR), and Washington, DC [Ashburn] (DC).
  • APAC - comprises Adelaide (AE), Brisbane (BR), Canberra (CA), Hongkong (HK), Jakarta (JK), Melbourne (ME), Osaka (OS), Perth (PE), Seoul (SL), Shanghai (SH), Singapore (SG), Sydney (SY), and Tokyo (TY)
localVCBandwidthMax integer
 This is the max bandwidth for a local virtual connection.
Example: 10000
geoScopes array[string]
 A list of boundaries within which the connection traffic can be constrained.
Example: ["CONUS"]
connectedMetros array[object]
 Array of objects with connection latency data for the specified metros.
href string
 Absolute URL that returns the specified entity.
Example:https://api.equinix.com/fabric/v4/metros/MX
code string
 Metropolitan area identifier.
Example: MX
avgLatency integer
 Average monthly connection latency in ms.
Example: 133
remoteVCBandwidthMax integer
 Max bandwidth for the remote connection.
Example: 25000

If you get an "Access Denied" error, please contact your local Equinix Service Desk for help.

Get All Subscriber Metros

GET /fabric/v4/metros?presence=MY_PORTS
Method GET
URL or Endpoint /fabric/v4/metros
Headers Content-Type, Authorization
Path Parameters Not applicable
Query Parameters offset, limit, presence
Body Parameters pagination, data

GET All Subscriber Metros uses the /fabric/v4/metros endpoint with an option query parameter to return all Equinix Fabric™ metros in which the customer has a presence, as well as latency data for each location. Network planning engineers and administrators can then analyze this performance data in making strategic decisions about port utilization.

To learn how to obtain an authorization token, see Requesting Access and Refresh Tokens under the Getting Access Token section.


Sample cURL request

Copy 
curl --location --request GET
https://api.equinix.com/fabric/v4/metros?presence=MY_PORTS
-H "Content-Type: application/json"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI" 

Query parameters

Parameter Name Mandatory Type Example Applicable Values Description
offset no integer ?offset=0 >=0 Index of the first item returned in the response. The default is 0.
limit no integer ?limit=75 [1 .. 100] Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 10.
presence no string ?presence=MY_PORTS MY_PORTS Returns all ports associated with the customer's account, as well as latency data for each port.

Response body

Copy 
{
"pagination": {
    "offset": 0,
    "limit": 75,
    "total": 12
},
"data": [
    {
    "href": "https://api.equinix.com/fabric/v4/metros/AM",

    "type": "XF_METRO",     
    "code": "AM",

    "name": "Amsterdam",
    "region": "EMEA",     
    "localVCBandwidthMax": 10000,
    "connectedMetros": [
        {
        "href": "https://api.equinix.com/fabric/v4/metros/MX",

        "code": "MX",
        "avgLatency": 133,
        "remoteVCBandwidthMax": 10000
        },
        {
        "href": "https://api.equinix.com/fabric/v4/metros/HH", 

        "code": "HH",
        "avgLatency": 8.65,
        "remoteVCBandwidthMax": 10000
        },
        {
        "href": "https://api.equinix.com/fabric/v4/metros/SL",

        "code": "SL",
        "avgLatency": 230,
        "remoteVCBandwidthMax": 25000
        },
        {
        "href": "https://api.equinix.com/fabric/v4/metros/SO",

        "code": "SO",
        "avgLatency": 36.5,
        "remoteVCBandwidthMax": 50000
        }
    ]
    }
]
}

Response body description

Field Data Type Example Description
pagination object Pagination specifications for the response data.
data array[object] Data returned from the API call.
pagination object
offset integer 0 Index of the first element returned in the response. The default is 0.
limit integer 75 Maximum number of elements returned. The default value is 75.
total integer 12 Total number of elements returned.
data array
href string https://api.equinix.com/fabric/v4/metros/AM The canonical URL at which the resource resides.
type string XF_METRO Indicator of a Fabric metro.
code string AM Code assigned to an Equinix International Business Exchange (IBX) data center in a specified metropolitan area.
name string Amsterdam Name of the city in which the data center is located.
region string EMEA Broad geographic area in which the data center is located (EMEA, AMER, or APAC):

EMEA comprises Abhu Dhabi (AD), Amsterdam (AM), Barcelona (BA), Dubai (DX), Dublin (DB), Dusseldorf (DU), Enschede (EN), Frankfurt (FR), Geneva (GV), Hamburg (HH), Helsinki (HE), Istanbul (IL), Lisbon (LS), London (LD), Madrid (MD), Manchester (MA), Milan (ML), Munich (MU), Muscat (MC), Paris (PA), Seville (SA), Sofia (SO), Stockholm (SK), Warsaw (WA), Zurich (ZH), and Zwolle (ZW).

AMER comprises Atlanta (AT), Bogota (BG), Boston (BO), Chicago (CH), Culpepper (CU), Dallas (DA), Denver (DE), Houston (HO), Los Angeles (LA), Mexico City (MX), Miami (MI), Monterrey (MO), Montreal (MT), New York (NY), Philadelphia (PH), Rio de Janeiro (RJ), Sao Paulo (SP), Seattle (SE), Silicon Valley (SV), Toronto (TR), and Washington, DC [Ashburn] (DC).

APAC comprises Adelaide (AE), Brisbane (BR), Canberra (CA), Hongkong (HK), Jakarta (JK), Melbourne (ME), Osaka (OS), Perth (PE), Seoul (SL), Shanghai (SH), Singapore (SG), Sydney (SY), and Tokyo (TY).
localVCBandwidthMax integer 10000 Max bandwidth of a local connection.
Example: 10000
connectedMetros array[object] Array of objects containing latency data for the specified metros.
data.connectedMetros
href string https://api.equinix.com/fabric/v4/metros/MX Canonical URL at which the resource resides.
code string MX Code assigned to an Equinix International Business Exchange (IBX) data center in a specified metropolitan area.
avgLatency integer 133.0 Average monthly latency (in milliseconds[ms]) between two specified metros.
remoteVCBandwidthMax integer 50000 Max bandwidth of the remote connection.
Example: 50000

If you get an "Access Denied" error, please contact your local Equinix Service Desk for help.