Product Availability
Get IBX Data Centers
GET /internetAccess/v1/ibxs | |
---|---|
Method | GET |
Endpoint | /internetAccess/v1/ibxs |
Headers | Authorization |
Path Parameters | Not applicable |
Query Parameters | offset, limit, service.connection.type, connection.aside.accessPoint.type |
Body Parameters | Not applicable |
This API request returns IBX data centers where Equinix Internet Access is available.
In addition to IBX data centers returned by this API, Equinix Internet Access with Dedicated Port service is also available for offline ordering in select Equinix facilities in Bulgaria, China, Poland, and Turkey. To order Equinix Internet Access service in one of those countries, contact your Equinix sales representative.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/ibxs?service.connection.type=IA_C&offset=0&limit=20'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Query parameters
Parameter | Description |
---|---|
offset integer OPTIONAL | Index of the first item returned in the response. Default value: 0 |
limit integer OPTIONAL | Maximum number of items returned per page. Default value: 50 |
service.connection.type string REQUIRED | Service connection type. Applicable values:
|
connection.aside.accessPoint.type string OPTIONAL | Connection's A-side access point type. Applicable values:
|
Sample response
{
"pagination": {
"offset": 0,
"limit": 20,
"total": 1
},
"data": [
{
"countryCode": "US",
"countryName": "United States",
"region": "AMER",
"metroCode": "DC",
"metroName": "Washington D.C.",
"ibx": "DC5",
"geoCoordinates": {
"latitude": 39.015958,
"longitude": -77.461263
}
}
]
}
Response payload body description
Parameter | Description |
---|---|
pagination object | Data set pagination information. |
offset integer | Index of the first item returned in the response. |
limit integer | Maximum number of items returned per page. |
total integer | Total number of items. |
data array[object] | Data set containing IBX data centers where Equinix Internet Access is available. |
countryCode string | 2-letter ISO country code of IBX data center. Example: US |
countryName string | Name of the country where the IBX data center is located. Example: United States |
region string | Broad geographical region. Possible values:
|
metroCode string | Metropolitan area code. Example: DC |
metroName string | Metropolitan area name. Example: Washington D.C. |
ibx string | IBX data center identifier. Example: DC5 |
geoCoordinates object | IBX data center location geo-coordinates. |
latitude number | Latitude of IBX data center. Example: 39.015958 |
longitude number | Longitude of IBX data center. Example: -77.461263 |
Get Specified IBX Data Center
GET /internetAccess/v1/ibxs/{ibx} | |
---|---|
Method | GET |
Endpoint | /internetAccess/v1/ibxs/{ibx} |
Headers | Authorization |
Path Parameters | ibx |
Query Parameters | service.connection.type |
Body Parameters | Not applicable |
This API request returns information on a specified IBX data center.
Sample curl request
curl -X GET 'https://api.equinix.com/internetAccess/v1/ibxs/DC5'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
Path parameters
Parameter | Description |
---|---|
ibx string REQUIRED | IBX data center identifier. Applicable values: Use the Get IBX Data Centers API request to retrieve IBX data centers where Equinix Internet Access is available. Example: DC5 |
Query parameters
Parameter | Description |
---|---|
service.connection.type string OPTIONAL | Service connection type. Applicable values:
|
connection.aside.accessPoint.type string OPTIONAL | Connection's A-side access point type. Applicable values:
|
Sample response
{
"countryCode": "US",
"countryName": "United States",
"region": "AMER",
"metroCode": "DC",
"metroName": "Washington D.C.",
"ibx": "DC5",
"geoCoordinates": {
"latitude": 39.015958,
"longitude": -77.461263
}
}
Response payload body description
Parameter | Description |
---|---|
countryCode string | 2-letter ISO country code of IBX data center. Example: US |
countryName string | Name of the country where the IBX data center is located. Example: United States |
region string | Broad geographical region. Possible values:
|
metroCode string | Metropolitan area code. Example: DC |
metroName string | Metropolitan area name. Example: Washington D.C. |
ibx string | IBX data center identifier. Example: DC5 |
geoCoordinates object | IBX data center location geo-coordinates. |
latitude number | Latitude of IBX data center. Example: 39.015958 |
longitude number | Longitude of IBX data center. Example: -77.461263 |