Skip to main content

Effective 10 September 2024, API Documentation can be found on our Equinix Product Documentation site.
The content on this page will not be updated after 1 Oct 2024 and will be inaccessible after 31st Dec 2024.


Connection Services

Get Connection Services

 GET /internetAccess/v1/connectionServices
MethodGET
Endpoint/internetAccess/v1/connectionServices
HeadersAuthorization
Path ParametersNot applicable
Query ParametersmediaTypes.connectorTypes.locations.ibx, offset, limit
Body ParametersNot applicable

This API request returns connection options available for ordering Equinix Internet Access.


Sample curl request

curl -X GET 'https://api.equinix.com/internetAccess/v1/connectionServices?mediaTypes.connectorTypes.locations.ibx=DC5'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Query parameters

Parameter
Description
mediaTypes.connectorTypes.locations.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
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

Sample response

{
"pagination": {
"offset": 0,
"limit": 20,
"total": 1
},
"data": [
{
"name": "Single-Mode Fiber",
"mediaTypes": [
{
"name": "Single-Mode Fiber",
"connectorTypes": [
{
"name": "LC",
"requiredPorts": 1,
"optionalPorts": 1,
"locations": [
{
"ibx": "DC5"
}
]
},
{
"name": "SC",
"requiredPorts": 2,
"optionalPorts": 0,
"locations": [
{
"ibx": "DC5"
}
]
},
{
"name": "ST",
"requiredPorts": 2,
"optionalPorts": 0,
"locations": [
{
"ibx": "DC5"
}
]
},
{
"name": "FC",
"requiredPorts": 2,
"optionalPorts": 0,
"locations": [
{
"ibx": "DC5"
}
]
}
]
}
]
}
]
}

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 available connection services.
name string
Name of connection service.
mediaTypes array[object]
List of media type objects.
name string
Media type name.
Example: Single-Mode Fiber
connectorTypes array[object]
Connector types.
name string
Connector type name.
Possible values:
  • LC - Lucent connector
  • SC - Standard connector
  • ST - Straight tip connector
  • FC - Ferrule core connector
requiredPorts number
Number of ports required by a given connector type.
Example: 2
optionalPorts number
Number of optional ports for a given connector type.
Example: 0
locations array[object]
Connection service locations.
ibx string
IBX data center identifier.
Example: DC5