Determine Connection Price
Determine costs for a specified Equinix Fabric connection.
Determine EVPL Connection Price
Determine costs of an Ethernet Virtual Private Line connection.
Step 1: Authenticate
Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.
Refer to Generating Client ID and Client Secret under the Getting Access Token section for instructions on how to create client ID and client secret and refer to Requesting Access and Refresh tokens section for instructions on how to call Oauth API to validate and authenticate your credentials.
If you are unaware of your user credentials for Equinix Fabric, contact your local Equinix Service Desk.
Step 2: Get Attribute Information
1. Determine A-side location
Use the
Get All Metros
API request to find all metros where Equinix Fabric is available or use
the
Get All Ports
API request to determine origin location based on the port.
2. Choose Z-side metro location
Use the
Get All Metros
API request to find all metros where Equinix Fabric is available and
determine destination location.
3. Identify service profile
Use the
Get Service Profiles
API request to list all service profiles available for a given metro or
metros, and identify the profile you want to connect to.
Step 3: Retrieve Pricing Information
Use the POST /fabric/v4/prices/search API request to retrieve connection price estimates using pre-determined values.
POST /fabric/v4/prices/search | |
---|---|
Method | POST |
URL or Endpoint | /fabric/v4/prices/search |
Headers | Authorization, Content-Type |
Path Parameters | Not applicable |
Query Parameters | Not applicable |
Body Parameters | filter |
Sample curl request - pricing information for a virtual port
curl -X POST 'http://api.equinix.com/fabric/v4/prices/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"filter": {
"and": [
{
"property": "/type",
"operator": "=",
"values": [
"VIRTUAL_PORT_PRODUCT"
]
},
{
"property": "/account/accountNumber",
"operator": "=",
"values": [
270001
]
},
{
"property": "/port/location/ibx",
"operator": "=",
"values": [
"DA1"
]
},
{
"property": "/port/type",
"operator": "=",
"values": [
"XF_PORT"
]
},
{
"property": "/port/bandwidth",
"operator": "=",
"values": [
1000
]
},
{
"property": "/port/settings/buyout",
"operator": "=",
"values": [
false
]
},
{
"property": "/port/serviceType",
"operator": "=",
"values": [
"EPL"
]
},
{
"property": "/port/connectivitySource/type",
"operator": "=",
"values": [
"COLO"
]
},
{
"property": "/port/lag/enabled",
"operator": "=",
"values": [
false
]
}
]
}
}'
Sample curl request - pricing information for a connection between two colocation endpoints
curl -X POST 'http://api.equinix.com/fabric/v4/prices/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"filter": {
"and": [
{
"property": "/type",
"operator": "=",
"values": [
"VIRTUAL_CONNECTION_PRODUCT"
]
},
{
"property": "/connection/type",
"operator": "=",
"values": [
"EVPL_VC"
]
},
{
"property": "/connection/bandwidth",
"operator": "IN",
"values": [
50,
1000
]
},
{
"property": "/connection/aSide/accessPoint/type",
"operator": "=",
"values": [
"COLO"
]
},
{
"property": "/connection/aSide/accessPoint/uuid",
"operator": "=",
"values": [
"b840a1db-54ab-4abf-97e0-328a5c00a874"
]
},
{
"property": "/connection/zSide/accessPoint/location/metroCode",
"operator": "=",
"values": [
"DC"
]
},
{
"property": "/connection/zSide/accessPoint/type",
"operator": "=",
"values": [
"COLO"
]
}
]
}
}'
Sample curl request - pricing information for a connection between a virtual device and a colocation endpoint
curl -X POST 'http://api.equinix.com/fabric/v4/prices/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"filter": {
"and": [
{
"property": "/type",
"operator": "=",
"values": [
"VIRTUAL_CONNECTION_PRODUCT"
]
},
{
"property": "/connection/type",
"operator": "=",
"values": [
"EVPL_VC"
]
},
{
"property": "/connection/bandwidth",
"operator": "IN",
"values": [
50,
1000
]
},
{
"property": "/connection/aSide/accessPoint/type",
"operator": "=",
"values": [
"VD"
]
},
{
"property": "/connection/aSide/accessPoint/",
"operator": "=",
"values": [
"CH"
]
},
{
"property": "/connection/zSide/accessPoint/location/metroCode",
"operator": "=",
"values": [
"DC"
]
},
{
"property": "/connection/zSide/accessPoint/type",
"operator": "=",
"values": [
"COLO"
]
}
]
}
}'
Body parameters
Parameter Name | Mandatory | Data Type | Example | Applicable Values | Description |
filter | yes | object | - | - | Array of objects defining search conditions. |
and | yes | array[object] | - | - | Logical operator. |
property | yes | string | /type | /type
/account/accountNumber /connection/type /connection/bandwidth /connection/aSide/accessPoint/type /connection/aSide/accessPoint/uuid /connection/aSide/accessPoint/location/metroCode /connection/aSide/accessPoint/port/settings/buyout /connection/zSide/accessPoint/location/metroCode /connection/zSide/accessPoint/type /connection/zSide/accessPoint/profile/uuid |
Search field parameter. Note that the property value determines the list of applicable operators and values. |
operator | yes | string | = | = IN |
Search field parameter operator. |
values | yes | array[string] | ["VIRTUAL_CONNECTION_PRODUCT"] | VIRTUAL_CONNECTION_PRODUCT | Search field parameter value. |
/type | yes |
"property": "/type", "operator": "=", "values": [ "VIRTUAL_CONNECTION_PRODUCT" ] |
Product type. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["VIRTUAL_CONNECTION_PRODUCT"] | VIRTUAL_CONNECTION_PRODUCT | - |
/account/accountNumber | no |
"property": "/account/accountNumber", "operator": "=", "values": [ 270001 ] |
Billing account number. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[integer] |
[270001] |
- | - |
|
|||||
/connection/type | yes |
"property": "/connection/type", "operator": "=", "values": [ "EVPL_VC" ] |
Connection type. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["EVPL_VC"] | EVPL_VC | EVPL_VC - Ethernet virtual private line‒virtual connection. |
/connection/bandwidth | yes |
"property": "/connection/bandwidth", "operator": "IN", "values": [ 200, 500 ] |
Connection bandwidth (Mbps). | ||
operator | yes | string | IN | IN | Search field parameter operator. |
values | yes | array[integer] | [200, 500] | 50 200 500 1000 2000 5000 10000 |
- |
/connection/aSide/accessPoint/type | yes |
"property": "/connection/aSide/accessPoint/type", "operator": "=", "values": [ "COLO" ] |
Type of access point. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["COLO"] |
COLO VD |
COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. |
/connection/aSide/accessPoint/uuid | no |
"property": "/connection/aSide/accessPoint/uuid", "operator": "=", "values": [ "20d32a80-0d61-4333-bc03-707b591ae2f1" ] |
Equinix-assigned port identifier. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["20d32a80-0d61-4333-bc03-707b591ae2f1"] |
Use the Get All Ports API request to retrieve the list of ports. |
- |
/connection/aSide /accessPoint/location/metroCode | conditional |
"property": "/connection/aSide/accessPoint/location/metroCode", "operator": "=", "values": [ "CH" ] |
Metropolitan area identifier. Required if/connection/aSide/accessPoint/uuid hasn't been provided. |
||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["CH"] |
Use the Get All Metros API request to retrieve the list of metros. |
- |
/connection/aSide /accessPoint/port/settings/buyout |
no |
"property": "/connection/aSide/accessPoint/port/settings/buyout", "operator": "=", "values": [ false ] |
Buyout (true) or standard (false) configuration of the port at this access point. Buyout ports offer free unlimited connections. Standard ports do not. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[boolean] | [true] | true false Default: false |
- |
/connection/zSide /accessPoint/location/metroCode |
no |
"property": "/connection/zSide/accessPoint/location/metroCode", "operator": "=", "values": [ "CH" ] |
|||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["SV"] |
Use the Get All Metros API request to retrieve the list of metros. |
Metropolitan area identifier. |
/connection/zSide/accessPoint/type | yes |
{ |
Type of access point. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["SP"] | COLO SP |
COLO - Colocation space in an IBX data center. SP - Service profile. |
/connection/zSide /accessPoint/profile/uuid | contitional |
"property": "/connection/zSide/accessPoint/profile/uuid", "operator": "=", "values": [ "20d32a80-0d61-4333-bc03-707b591ae2f2" ] |
Equinix-assigned service profile identifier. Required for the SP access point type. |
||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["20d32a80-0d61-4333-bc03-707b591ae2f2"] | - | - |
Sample response - pricing information for a connection between a colocation and a service profile endpoint
{
"data": [
{
"type": "VIRTUAL_CONNECTION_PRODUCT",
"code": "ECX00015.PROD",
"name": "Equinix Fabric Virtual Connection Product",
"description": "Equinix Fabric Virtual Connection",
"charges": [
{
"type": "MONTHLY_RECURRING",
"price": 250.0
}
],
"currency": "USD",
"connection": {
"type": "EVPL_VC",
"bandwidth": 50,
"aSide": {
"accessPoint": {
"type": "COLO",
"location": {
"metroCode": "CH"
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"location": {
"metroCode": "DC"
},
"profile": {
"uuid": "e0346949-00af-480b-801b-bdd2b8980c6e"
}
}
}
}
},
{
"type": "VIRTUAL_CONNECTION_PRODUCT",
"code": "ECX00015.PROD",
"name": "Equinix Fabric Virtual Connection Product",
"description": "Equinix Fabric Virtual Connection",
"charges": [
{
"type": "MONTHLY_RECURRING",
"price": 900.0
}
],
"currency": "USD",
"connection": {
"type": "EVPL_VC",
"bandwidth": 1000,
"aSide": {
"accessPoint": {
"type": "COLO",
"location": {
"metroCode": "CH"
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"location": {
"metroCode": "DC"
},
"profile": {
"uuid": "e0346949-00af-480b-801b-bdd2b8980c6e"
}
}
}
}
}
],
"pagination": {
"offset": 0,
"limit": 2,
"total": 2
}
}
Response payload body description
Field Name | Data Type | Example Values | Description |
type | string | VIRTUAL_CONNECTION_PRODUCT | Product type. |
code |
string | ECX00015.PROD | Product code. |
name |
string | Equinix Fabric Virtual Connection Product | Product name. |
description |
string | Equinix Fabric Virtual Connection | Product description. |
charges | array[object] | — | List of product offerings with properties and prices. |
currency | string | USD | Product offering price currency. |
conenction | object | — | Connection information. |
charges | |||
type | string | MONTHLY_RECURRING | Charge type. |
price | number | 900.0 | Offering price. |
connection | |||
type | string | EVPL_VC | Connection type. |
bandwidth |
integer | 1000 | Connection bandwidth (Mbps). |
aSide/zSide | object | — | An aSide (subscriber) or zSide (provider) connection configuration. |
connection.aSide/zSide | |||
accessPoint | object | — | Carrier-neutral network hub for interconnectivity among global internet access providers. |
connection.aSide/zSide.accessPoint | |||
type |
string | SP | Type of access point. |
location | object | — | Attributes associated with the location of the specified connection. |
connection.aSide/zSide.accessPoint.location | |||
metroCode |
string | CH | Metropolitan area identifier. |
pagination | |||
offset | integer | 0 | Index of the first item returned in the response. |
limit | integer | 2 | Maximum number of items returned per page. |
total | integer | 2 | Total number of items that match request criteria. |
If you get "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.
Determine Fabric Cloud Router Connection Price
Determine costs of a connection originating from a Fabric Cloud Router or a Network Edge virtual device.
Step 1: Authenticate
Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.
Refer to Generating Client ID and Client Secret under the Getting Access Token section for instructions on how to create client ID and client secret and refer to Requesting Access and Refresh tokens section for instructions on how to call Oauth API to validate and authenticate your credentials.
If you are unaware of your user credentials for Equinix Fabric, contact your local Equinix Service Desk.
Step 2: Get Attribute Information
1. Determine A-side location
Use the
Get All Metros
API request to find all metros where Equinix Fabric is available and
determine conection origin location.
2. Choose Z-side metro location
Use the
Get All Metros
API request to find all metros where Equinix Fabric is available and
determine destination location.
3. Identify service profile
Use the
Get Services
API request to list all service profiles available for a given metro or
metros, and identify the profile you want to connect to.
Step 3: Retrieve Pricing Information
Use the POST /fabric/v4/prices/search API request to retrieve connection price estimates using pre-determined values.
POST /fabric/v4/prices/search | |
---|---|
Method | POST |
URL or Endpoint | /fabric/v4/prices/search |
Headers | Authorization, Content-Type |
Path Parameters | Not applicable |
Query Parameters | Not applicable |
Body Parameters | filter |
Sample curl request - pricing information for a connection between a Fabric Cloud Router and a colocation endpoint
curl -X POST 'http://api.equinix.com/fabric/v4/prices/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"filter": {
"and": [
{
"property": "/type",
"operator": "=",
"values": [
"VIRTUAL_CONNECTION_PRODUCT"
]
},
{
"property": "/connection/type",
"operator": "=",
"values": [
"GW_VC"
]
},
{
"property": "/connection/bandwidth",
"operator": "IN",
"values": [
50,
1000
]
},
{
"property": "/connection/aSide/accessPoint/type",
"operator": "=",
"values": [
"GW"
]
},
{
"property": "/connection/aSide/accessPoint/location/metroCode",
"operator": "=",
"values": [
"CH"
]
},
{
"property": "/connection/zSide/accessPoint/type",
"operator": "=",
"values": [
"COLO"
]
},
{
"property": "/connection/zSide/accessPoint/location/metroCode",
"operator": "=",
"values": [
"DC"
]
}
]
}
}'
Sample curl request - pricing information for a connection between a virtual device and a service profile
curl -X POST 'http://api.equinix.com/fabric/v4/prices/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"filter": {
"and": [
{
"property": "/type",
"operator": "=",
"values": [
"VIRTUAL_CONNECTION_PRODUCT"
]
},
{
"property": "/connection/type",
"operator": "=",
"values": [
"GW_VC"
]
},
{
"property": "/connection/bandwidth",
"operator": "IN",
"values": [
50,
1000
]
},
{
"property": "/connection/aSide/accessPoint/type",
"operator": "=",
"values": [
"VD"
]
},
{
"property": "/connection/aSide/accessPoint/location/metroCode",
"operator": "=",
"values": [
"CH"
]
},
{
"property": "/connection/zSide/accessPoint/location/metroCode",
"operator": "=",
"values": [
"DC"
]
},
{
"property": "/connection/zSide/accessPoint/type",
"operator": "=",
"values": [
"SP"
]
},
{
"property": "/connection/zSide/accessPoint/profile/uuid",
"operator": "=",
"values": [
"e0346949-00af-480b-801b-bdd2b8980c6e"
]
}
]
}
}'
Body parameters
Parameter Name | Mandatory | Data Type | Example | Applicable Values | Description |
filter | yes | object | - | - | Array of objects defining search conditions. |
and | yes | array[object] | - | - | Logical operator. |
property | yes | string | /type | /type
/account/accountNumber /connection/type /connection/bandwidth /connection/aSide/accessPoint/type /connection/aSide/accessPoint/uuid /connection/aSide/accessPoint/location/metroCode /connection/aSide/accessPoint/port/settings/buyout /connection/zSide/accessPoint/location/metroCode /connection/zSide/accessPoint/type /connection/zSide/accessPoint/profile/uuid |
Search field parameter. Note that the property value determines the list of applicable operators and values. |
operator | yes | string | = | = IN |
Search field parameter operator. |
values | yes | array[string] | ["VIRTUAL_CONNECTION_PRODUCT"] | VIRTUAL_CONNECTION_PRODUCT | Search field parameter value. |
/type | yes |
"property": "/type", "operator": "=", "values": [ "VIRTUAL_CONNECTION_PRODUCT" ] |
Product type. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["VIRTUAL_CONNECTION_PRODUCT"] | VIRTUAL_CONNECTION_PRODUCT | - |
/account/accountNumber | no |
"property": "/account/accountNumber", "operator": "=", "values": [ 270001 ] |
Billing account number. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[integer] |
[270001] |
- | - |
|
|||||
/connection/type | yes |
"property": "/connection/type", "operator": "=", "values": [ "GW_VC" ] |
Connection type. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["GW_VC"] | GW_VC | GW_VC - Fabric Cloud Router virtual connection. |
/connection/bandwidth | yes |
"property": "/connection/bandwidth", "operator": "IN", "values": [ 200, 500 ] |
Connection bandwidth (Mbps). | ||
operator | yes | string | IN | IN | Search field parameter operator. |
values | yes | array[integer] | [200, 500] | 50 200 500 1000 2000 5000 10000 |
- |
/connection/aSide/accessPoint/type | yes |
"property": "/connection/aSide/accessPoint/type", "operator": "=", "values": [ "GW" ] |
Type of access point. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["GW"] |
GW VD |
GW - Fabric Cloud Router instance. VD - Network Edge virtual device. |
/connection/aSide /accessPoint/location/metroCode | yes |
"property": "/connection/aSide/accessPoint/location/metroCode", "operator": "=", "values": [ "CH" ] |
Metropolitan area identifier. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["CH"] |
Use the Get All Metros API request to retrieve the list of metros. |
- |
/connection/zSide /accessPoint/location/metroCode |
no |
"property": "/connection/zSide/accessPoint/location/metroCode", "operator": "=", "values": [ "CH" ] |
Metropolitan area identifier. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["SV"] |
Use the Get All Metros API request to retrieve the list of metros. |
- |
/connection/zSide /accessPoint/type | yes |
{ |
Type of access point. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["SP"] | COLO SP |
COLO - Colocation space in an Equinix IBX data center. SP - Service profile. |
/connection/zSide /accessPoint/profile/uuid | contitional |
"property": "/connection/zSide/accessPoint/profile/uuid", "operator": "=", "values": [ "20d32a80-0d61-4333-bc03-707b591ae2f2" ] |
Equinix-assigned service profile identifier. Required for the SP access point type. |
||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["20d32a80-0d61-4333-bc03-707b591ae2f2"] | - | - |
Sample response - pricing information for a connection between a Fabric Cloud Router and a colocation endpoint
{
"data": [
{
"type": "VIRTUAL_CONNECTION_PRODUCT",
"code": "ECX00015.PROD",
"name": "Equinix Fabric Virtual Connection Product",
"description": "Equinix Fabric Virtual Connection",
"charges": [
{
"type": "MONTHLY_RECURRING",
"price": 200.0
}
],
"currency": "USD",
"connection": {
"type": "GW_VC",
"bandwidth": 50,
"aSide": {
"accessPoint": {
"type": "GW",
"location": {
"metroCode": "CH"
}
}
},
"zSide": {
"accessPoint": {
"type": "COLO",
"location": {
"metroCode": "DC"
}
}
}
}
},
{
"type": "VIRTUAL_CONNECTION_PRODUCT",
"code": "ECX00015.PROD",
"name": "Equinix Fabric Virtual Connection Product",
"description": "Equinix Fabric Virtual Connection",
"charges": [
{
"type": "MONTHLY_RECURRING",
"price": 500.0
}
],
"currency": "USD",
"connection": {
"type": "GW_VC",
"bandwidth": 1000,
"aSide": {
"accessPoint": {
"type": "GW",
"location": {
"metroCode": "CH"
}
}
},
"zSide": {
"accessPoint": {
"type": "COLO",
"location": {
"metroCode": "DC"
}
}
}
}
}
],
"pagination": {
"offset": 0,
"limit": 2,
"total": 2
}
}
Response payload body description
Field Name | Data Type | Example Values | Description |
type | string | VIRTUAL_CONNECTION_PRODUCT | Product type. |
code |
string | ECX00015.PROD | Product code. |
name |
string | Equinix Fabric Virtual Connection Product | Product name. |
description |
string | Equinix Fabric Virtual Connection | Product description. |
charges | array[object] | — | List of product offerings with properties and prices. |
currency | string | USD | Product offering price currency. |
conenction | object | — | Connection information. |
charges | |||
type | string | MONTHLY_RECURRING | Charge type. |
price | number | 900.0 | Offering price. |
connection | |||
type | string | GW_VC | Connection type. |
bandwidth |
integer | 1000 | Connection bandwidth (Mbps). |
aSide/zSide | object | — | An A side (subscriber) or Z side (provider) connection configuration. |
connection.aSide/zSide | |||
accessPoint | object | — | Carrier-neutral network hub for interconnectivity among global internet access providers. |
connection.aSide/zSide.accessPoint | |||
type |
string | SP | Type of access point. |
location | object | — | Attributes associated with the location of the specified connection. |
connection.aSide/zSide.accessPoint.location | |||
metroCode |
string | CH | Metropolitan area identifier. |
pagination | |||
offset | integer | 0 | Index of the first item returned in the response. |
limit | integer | 2 | Maximum number of items returned per page. |
total | integer | 2 | Total number of items that match request criteria. |
If you get "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.
Determine Device Link Connection Price
Determine costs of a device link connection.
For information on device linking, refer to Network Edge: Device Link.
Step 1: Authenticate
Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.
Refer to Generating Client ID and Client Secret under the Getting Access Token section for instructions on how to create client ID and client secret and refer to Requesting Access and Refresh tokens section for instructions on how to call Oauth API to validate and authenticate your credentials.
If you are unaware of your user credentials for Equinix Fabric, contact your local Equinix Service Desk.
Step 2: Get Attribute Information
Use the Get All Metros API request to find all metros where Equinix Fabric is available and determine connection origin location.
Step 3: Retrieve Pricing Information
Use the POST /fabric/v4/prices/search API request to retrieve connection price estimates using pre-determined values.
POST /fabric/v4/prices/search | |
---|---|
Method | POST |
URL or Endpoint | /fabric/v4/prices/search |
Headers | Authorization, Content-Type |
Path Parameters | Not applicable |
Query Parameters | Not applicable |
Body Parameters | filter |
Sample curl request - pricing information for a device link connection
curl -X POST 'http://api.equinix.com/fabric/v4/prices/search'
curl -X POST 'http://api.equinix.com/fabric/v4/prices/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"filter": {
"and": [
{
"property": "/type",
"operator": "=",
"values": [
"VIRTUAL_CONNECTION_PRODUCT"
]
},
{
"property": "/connection/type",
"operator": "=",
"values": [
"VD_CHAIN_VC"
]
},
{
"property": "/connection/bandwidth",
"operator": "IN",
"values": [
50,
1000
]
},
{
"property": "/connection/aSide/accessPoint/type",
"operator": "=",
"values": [
"VD"
]
},
{
"property": "/connection/aSide/accessPoint/location/metroCode",
"operator": "=",
"values": [
"CH"
]
},
{
"property": "/connection/zSide/accessPoint/type",
"operator": "=",
"values": [
"CHAINGROUP"
]
},
{
"property": "/connection/zSide/accessPoint/bridge/package/code",
"operator": "=",
"values": [
"GLOBAL"
]
}
]
}
}'
Body parameters
Parameter Name | Mandatory | Data Type | Example | Applicable Values | Description |
filter | yes | object | - | - | Array of objects defining search conditions. |
and | yes | array[object] | - | - | Logical operator. |
property | yes | string | /type | /type
/account/accountNumber /connection/type /connection/bandwidth /connection/aSide/accessPoint/type /connection/aSide/accessPoint/location/metroCode /connection/zSide/accessPoint/type /connection/zSide/accessPoint/bridge/package/code |
Search field parameter. Note that the property value determines the list of applicable operators and values. |
operator | yes | string | = | = IN |
Search field parameter operator. |
values | yes | array[string] | ["VIRTUAL_CONNECTION_PRODUCT"] | VIRTUAL_CONNECTION_PRODUCT | Search field parameter value. |
/type | yes |
"property": "/type", "operator": "=", "values": [ "VIRTUAL_CONNECTION_PRODUCT" ] |
Product type. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["VIRTUAL_CONNECTION_PRODUCT"] | VIRTUAL_CONNECTION_PRODUCT | - |
/account/accountNumber | no |
"property": "/account/accountNumber", "operator": "=", "values": [ 270001 ] |
Billing account number. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[integer] |
[270001] |
- | - |
|
|||||
/connection/type | yes |
"property": "/connection/type", "operator": "=", "values": [ "VD_CHAIN_VC" ] |
Connection type. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["VD_CHAIN_VC"] | VD_CHAIN_VC | VD_CHAIN_VC - Device link connection. |
/connection/bandwidth | yes |
"property": "/connection/bandwidth", "operator": "IN", "values": [ 200, 500 ] |
Connection bandwidth (Mbps). | ||
operator | yes | string | IN | IN | Search field parameter operator. |
values | yes | array[integer] | [200, 500] | 50 200 500 1000 2000 5000 10000 |
- |
/connection/aSide/accessPoint/type | yes |
"property": "/connection/aSide/accessPoint/type", "operator": "=", "values": [ "VD" ] |
Type of access point. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["VD"] |
VD | VD - Network Edge virtual device. |
/connection/aSide /accessPoint/location/metroCode | yes |
"property": "/connection/aSide/accessPoint/location/metroCode", "operator": "=", "values": [ "CH" ] |
Metropolitan area identifier. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["CH"] |
Use the Get All Metros API request to retrieve the list of metros. |
- |
/connection/zSide/accessPoint/type | yes |
{ |
Type of access point. | ||
operator | yes | string | = | = | Search field parameter operator. |
values | yes | array[string] | ["CHAINGROUP"] | CHAINGROUP | CHAINGROUP - Device link group. |
/connection/zSide /accessPoint/bridge/package/code | yes |
"property": "/connection/zSide/accessPoint/bridge/package/code", "operator": "=", "values": [ "GLOBAL" ] |
Bridge package configuration code. | ||
operator | yes | string | = | = | |
values | yes | array[string] | ["GLOBAL"] | GLOBAL REGIONAL |
GLOBAL - For devices deployed between different metros. REGIONAL - For devices deployed within the same metro. |
Sample response
{
"data": [
{
"type": "VIRTUAL_CONNECTION_PRODUCT",
"code": "ECX00015.PROD",
"name": "Equinix Fabric Virtual Connection Product",
"description": "Equinix Fabric Virtual Connection",
"charges": [
{
"type": "MONTHLY_RECURRING",
"price": 500.0
}
],
"currency": "USD",
"connection": {
"type": "VD_CHAIN_VC",
"bandwidth": 1000,
"aSide": {
"accessPoint": {
"type": "VD",
"location": {
"metroCode": "CH"
}
}
},
"zSide": {
"accessPoint": {
"type": "CHAINGROUP",
"bridge": {
"package": {
"code": "GLOBAL"
}
}
}
}
}
},
{
"type": "VIRTUAL_CONNECTION_PRODUCT",
"code": "ECX00015.PROD",
"name": "Equinix Fabric Virtual Connection Product",
"description": "Equinix Fabric Virtual Connection",
"charges": [
{
"type": "MONTHLY_RECURRING",
"price": 200.0
}
],
"currency": "USD",
"connection": {
"type": "VD_CHAIN_VC",
"bandwidth": 50,
"aSide": {
"accessPoint": {
"type": "VD",
"location": {
"metroCode": "CH"
}
}
},
"zSide": {
"accessPoint": {
"type": "CHAINGROUP",
"bridge": {
"package": {
"code": "GLOBAL"
}
}
}
}
}
}
],
"pagination": {
"offset": 0,
"limit": 2,
"total": 2
}
}
Response payload body description
Field Name | Data Type | Example Values | Description |
type | string | VIRTUAL_CONNECTION_PRODUCT | Product type. |
code |
string | ECX00015.PROD | Product code. |
name |
string | Equinix Fabric Virtual Connection Product | Product name. |
description |
string | Equinix Fabric Virtual Connection | Product description. |
charges | array[object] | — | List of product offerings with properties and prices. |
currency | string | USD | Product offering price currency. |
conenction | object | — | Connection information. |
charges | |||
type | string | MONTHLY_RECURRING | Charge type. |
price | number | 900.0 | Offering price. |
connection | |||
type | string | VD_CHAIN_VC | Connection type. |
bandwidth |
integer | 1000 | Connection bandwidth (Mbps). |
aSide/zSide | object | — | An A side (subscriber) or Z side (provider) connection configuration. |
connection.aSide/zSide | |||
accessPoint | object | — | Carrier-neutral network hub for interconnectivity among global internet access providers. |
connection.aSide/zSide.accessPoint | |||
type |
string | CHAINGROUP | Type of access point. |
bridge | object | — | Attributes associated with the bridge configuration. |
connection.aSide/zSide.accessPoint.bridge | |||
object | — | Bridge package attributes. | |
connection.aSide/zSide.accessPoint.bridge.package | |||
code | string | GLOBAL |
Bridge package configuration code. GLOBAL - For devices deployed between different metros. REGIONAL - For devices deployed within the same metro. |
pagination | |||
offset | integer | 0 | Index of the first item returned in the response. |
limit | integer | 2 | Maximum number of items returned per page. |
total | integer | 2 | Total number of items that match request criteria. |
If you get "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.