Connect to Microsoft Azure - Parameters Mapping
- Non-redundant connection to Microsoft Azure ExpressRoute from a DOT1Q port
- Non-redundant connection to Microsoft Azure ExpressRoute from a QINQ port
- Redundant connections to Microsoft Azure ExpressRoute from DOT1Q ports
- Redundant connections to Microsoft Azure ExpressRoute from QINQ ports
Non-redundant connection to Microsoft Azure ExpressRoute from a DOT1Q port
v3 request
curl -X
POST 'http://api.equinix.com/ecx/v3/l2/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"primaryName": "JohnDoe_Dot1q_Private",
"profileUUID": "84c6616c-573a-447d-a478-9fab8fff284d",
"speed": 50,
"speedUnit": "MB",
"purchaseOrderNumber": "",
"primaryPortUUID": "7f891d3b-973e-73e0-bae0-30ac1885197a",
"primaryVlanSTag": "458",
"secondaryName": "TestS110",
"secondaryVlanSTag": "442",
"secondaryPortUUID": "7f891d3b-9740-7400-bae0-30ac1885197a",
"namedTag": "Private",
"sellerMetroCode": "SV",
"authorizationKey": "76e781b5-2992-4042-b2a2-37d0d5eb6735",
"notifications": [
"JohnDoe@example.com"
]
}'
v4 request
curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"type": "EVPL_VC",
"name": "Conn-1",
"order": {
"purchaseOrderNumber": "1-129105284100"
},
"bandwidth": 1000,
"redundancy": {
"priority": "PRIMARY"
},
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 1001
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"profile": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
},
"location": {
"metroCode": "SV"
},
"linkProtocol": {
"type": "QINQ",
"vlanCTag": 1001
},
"authenticationKey": "xx-xx-xx",
"peeringType": "PRIVATE"
}
},
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com"
]
}
]
}'
v3 API request | v4 API request | Description | |
POST /ecx/v3/l2/connections | POST /fabric/v4/connections | Request: v4 API introduces a more nested structure and new parameters to accomodate for new use case scenarios involving new entities. Response: v4 API reqest response includes the entire connection object, while the v3 API request returns only a request status message. | |
v3 parameter | v4 parameter | Example | Description |
- | type | EVPL_VC | New parameter defining connection type, introduced to support new use cases. EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. |
primaryName | name | Connection | Connection name. |
- | order | - | New container object for order details. |
purchaseOrderNumber | order.purchaseOrderNumber | 1-129105284100 | Subscriber's purchase order identifier. |
speed | bandwidth | 1000 | Connection bandwidth. |
speedUnit | - | - | In the v4 API the connection bandwidth is expressed in Mbps. |
- | aSide | - | New container object for A-side connection configuration. |
- | aSide.accessPoint | - | New container object for A-side connection access point. |
- | aSide.accessPoint.type | COLO | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. COLO - Colocation space in an IBX data center. |
- | aSide.accessPoint.port | - | New container object for A-side port configuration. |
primaryPortUUID | aSide.accessPoint.port.uuid | c791f8cb-5904-9040-8ce0-306a5c00a4ee | A-side port identifier. |
- | aSide.accessPoint.linkProtocol | - | New container object for link protocol configuration. |
- | aSide.accessPoint.linkProtocol.type | DOT1Q | New parameter that explicitly specifies the encapsulation standard. |
primaryVlanSTag | aSide.accessPoint.linkProtocol.vlanTag | 124 | DOT1Q encapsulation VLAN tag. |
- | zSide | - | New container object for Z-side connection configuration. |
- | zSide.accessPoint | - | New container object for Z-side connection access point. |
- | zSide.accessPoint.type | SP | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. SP - Service profile. |
- | zSide.accessPoint.profile | - | New container object for Z-side service profile configuration. |
profileUUID | zSide.accessPoint.profile.uuid | c791f8cb-5d01-d010-8ce0-306a5c00a4ee | Z-side profile identifier. |
- | zSide.accessPoint.location | - | New container object for endpoint location configuration. |
sellerMetroCode | zSide.accessPoint.location.metroCode | SV | Metropolitan area identifier. |
- | zSide.accessPoint.linkProtocol | - | New container object for link protocol configuration. |
- | zSide.accessPoint.linkProtocol.type | QINQ | New parameter that explicitly specifies the encapsulation standard. |
primaryZSideVlanCTag | zSide.accessPoint.linkProtocol.vlanCTag | 123 | QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. |
authorizationKey | zSide.accessPoint.authenticationKey | xx-xxx | Access point authentication key. |
namedTag | zSide.accessPoint.peeringType | PRIVATE | Access point peering type. Applicable to connections originating from DOT1Q ports. |
- | notifications | - | New object for email notifications configuration. |
- | notifications.type | ALL | New parameter enabling differentiation of notifications. |
notifications | notifications.emails | ["john@equinix.com", "jenkins@equinix.com"] | List of up to 12 recipients. |
Non-redundant connection to Microsoft Azure ExpressRoute from a QINQ port
v3 request
curl -X
POST 'http://api.equinix.com/ecx/v3/l2/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"purchaseOrderNumber": "1234567890",
"primaryName": "JohnDoe_Azure_QinQ",
"secondaryName": "JohnDoe2_Azure_QinQ",
"primaryPortUUID": "7f891d3b-973d-73d0-bae0-30ac1885197a",
"secondaryPortUUID": "7f891d3b-973d-73d0-bae0-30ac1885197a",
"primaryVlanSTag": 640,
"secondaryVlanSTag": 650,
"profileUUID": "84c6616c-573a-447d-a478-9fab8fff284d",
"authorizationKey": "e03da869-8243-4dac-ae49-a95c80f5425d",
"sellerMetroCode": "DC",
"speed": 50,
"speedUnit": "MB",
"notifications": [
"JohnDoe@example.com"
]
}'
v4 request
curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"type": "EVPL_VC",
"name": "Conn-1",
"order": {
"purchaseOrderNumber": "1-129105284100"
},
"bandwidth": 1000,
"redundancy": {
"priority": "PRIMARY"
},
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
},
"linkProtocol": {
"type": "QINQ",
"vlanSTag": 1003
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"profile": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
},
"location": {
"metroCode": "SV"
},
"linkProtocol": {
"type": "QINQ"
},
"authenticationKey": "xx-xx-xx"
}
},
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com"
]
}
]
}'
v3 API request | v4 API request | Description | |
POST /ecx/v3/l2/connections | POST /fabric/v4/connections | Request: v4 API introduces a more nested structure and new parameters to accomodate for new use case scenarios involving new entities. Response: v4 API reqest response includes the entire connection object, while the v3 API request returns only a request status message. | |
v3 parameter | v4 parameter | Example | Description |
- | type | EVPL_VC | New parameter defining connection type, introduced to support new use cases. EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. |
primaryName | name | Connection | Connection name. |
- | order | - | New container object for order details. |
purchaseOrderNumber | order.purchaseOrderNumber | 1-129105284100 | Subscriber's purchase order identifier. |
speed | bandwidth | 1000 | Connection bandwidth. |
speedUnit | - | - | In the v4 API the connection bandwidth is expressed in Mbps. |
- | aSide | - | New container object for A-side connection configuration. |
- | aSide.accessPoint | - | New container object for A-side connection access point. |
- | aSide.accessPoint.type | COLO | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. COLO - Colocation space in an IBX data center. |
- | aSide.accessPoint.port | - | New container object for A-side port configuration. |
primaryPortUUID | aSide.accessPoint.port.uuid | c791f8cb-5904-9040-8ce0-306a5c00a4ee | A-side port identifier. |
- | aSide.accessPoint.linkProtocol | - | New container object for link protocol configuration. |
- | aSide.accessPoint.linkProtocol.type | QINQ | New parameter that explicitly specifies the encapsulation standard. |
primaryVlanSTag | aSide.accessPoint.linkProtocol.vlanSTag | 124 | QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. |
- | zSide | - | New container object for Z-side connection configuration. |
- | zSide.accessPoint | - | New container object for Z-side connection access point. |
- | zSide.accessPoint.type | SP | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. SP - Service profile. |
- | zSide.accessPoint.profile | - | New container object for Z-side service profile configuration. |
profileUUID | zSide.accessPoint.profile.uuid | c791f8cb-5d01-d010-8ce0-306a5c00a4ee | Z-side profile identifier. |
- | zSide.accessPoint.location | - | New container object for endpoint location configuration. |
sellerMetroCode | zSide.accessPoint.location.metroCode | SV | Metropolitan area identifier. |
- | zSide.accessPoint.linkProtocol | - | New container object for link protocol configuration. |
- | zSide.accessPoint.linkProtocol.type | QINQ | New parameter that explicitly specifies the encapsulation standard. |
authorizationKey | zSide.accessPoint.authenticationKey | xx-xxx | Access point authentication key. |
namedTag | zSide.accessPoint.peeringType | PRIVATE | Access point peering type. Applicable to connections originating from DOT1Q ports. |
- | notifications | - | New object for email notifications configuration. |
- | notifications.type | ALL | New parameter enabling differentiation of notifications. |
notifications | notifications.emails | ["john@equinix.com", "jenkins@equinix.com"] | List of up to 12 recipients. |
Redundant connections to Microsoft Azure ExpressRoute from DOT1Q ports
v3 request
curl -X
POST 'http://api.equinix.com/ecx/v3/l2/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"primaryName": "JohnDoe_Dot1q_Private",
"profileUUID": "84c6616c-573a-447d-a478-9fab8fff284d",
"speed": 50,
"speedUnit": "MB",
"purchaseOrderNumber": "",
"primaryPortUUID": "7f891d3b-973e-73e0-bae0-30ac1885197a",
"primaryVlanSTag": "458",
"secondaryName": "TestS110",
"secondaryVlanSTag": "442",
"secondaryPortUUID": "7f891d3b-9740-7400-bae0-30ac1885197a",
"namedTag": "Private",
"sellerMetroCode": "SV",
"authorizationKey": "76e781b5-2992-4042-b2a2-37d0d5eb6735",
"notifications": [
"JohnDoe@example.com"
]
}'
v4 request
curl -X
POST 'https: //api.equinix.com/fabric/v4/connections/bulk'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"data": [
{
"type": "EVPL_VC",
"name": "Conn-1",
"order": {
"purchaseOrderNumber": "1-129105284100"
},
"bandwidth": 100,
"redundancy": {
"priority": "PRIMARY"
},
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 1001
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"profile": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
},
"location": {
"metroCode": "SV",
"region": "us-west-1"
},
"linkProtocol": {
"type": "QINQ",
"vlanSTag": 2001
},
"authenticationKey": "xx-xx-xx",
"peeringType": "PRIVATE"
}
}
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com",
"test1@equinix.com"
]
}
]
},
{
"type": "EVPL_VC",
"name": "Conn-2",
"order": {
"purchaseOrderNumber": "1-129105284100"
},
"bandwidth": 100,
"redundancy": {
"group": "j167f685-41b0-1b07-6de0-320a5c00abie",
"priority": "SECONDARY"
},
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 1002
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"profile": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
},
"location": {
"metroCode": "SV",
"region": "us-west-1"
},
"linkProtocol": {
"type": "QINQ",
"vlanSTag": 2002
},
"authenticationKey": "xx-xx-xx",
"peeringType": "PRIVATE"
}
}
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com",
"test1@equinix.com"
]
}
]
}
]
}'
v3 API request | v4 API request | Description | |
POST /ecx/v3/l2/connections | POST /fabric/v4/connections/bulk | V4 API introduces a new endpoint dedicated to creating redundant connections. | |
v3 parameter | v4 parameter | Example | Description |
- | data[0].type | EVPL_VC | New parameter defining connection type, introduced to support new use cases. EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. |
primaryName | data[0].name | Connection | Connection name. |
- | data[0].order | - | New container object for order details. |
purchaseOrderNumber | data[0].order.purchaseOrderNumber | 1-129105284100 | Subscriber's purchase order identifier. |
speed | data[0].bandwidth | 1000 | Connection bandwidth. |
speedUnit | - | - | In the v4 API the connection bandwidth is expressed in Mbps. |
- | data[0].redundancy | - | Redundancy details. Not required for primary connections |
- | data[0].redundancy.group | cea65afb-aa33-a336-2ae0-387a5c00a944 | Unique Id of the redundancy group. This is only required for secondary connections. If you are creating a secondary connection, enter the group of the PRIMARY. You can find the group of the primary connection by calling Get Specified Connection or by checking the response you received in the "group" field at the time of creating primary connection. |
- | data[0].redundancy.priority | PRIMARY | Whether the connection is PRIMARY or SECONDARY. Don't provide a redundancy group Id for a PRIMARY connection. |
- | data[0].aSide | - | New container object for A-side connection configuration. |
- | data[0].aSide.accessPoint | - | New container object for A-side connection access point. |
- | data[0].aSide.accessPoint.type | COLO | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. COLO - Colocation space in an IBX data center. |
- | data[0].aSide.accessPoint.port | - | New container object for A-side port configuration. |
primaryPortUUID | data[0].aSide.accessPoint.port.uuid | c791f8cb-5904-9040-8ce0-306a5c00a4ee | A-side port identifier. |
- | data[0].aSide.accessPoint.linkProtocol | - | New container object for link protocol configuration. |
- | data[0].aSide.accessPoint.linkProtocol.type | DOT1Q | New parameter that explicitly specifies the encapsulation standard. |
primaryVlanSTag | data[0].aSide.accessPoint.linkProtocol.vlanTag | 124 | DOT1Q encapsulation VLAN tag. |
- | data[0].zSide | - | New container object for Z-side connection configuration. |
- | data[0].zSide.accessPoint | - | New container object for Z-side connection access point. |
- | data[0].zSide.accessPoint.type | SP | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. SP - Service profile. |
- | data[0].zSide.accessPoint.profile | - | New container object for Z-side service profile configuration. |
profileUUID | data[0].zSide.accessPoint.profile.uuid | c791f8cb-5d01-d010-8ce0-306a5c00a4ee | Z-side profile identifier. |
- | data[0].zSide.accessPoint.location | - | New container object for endpoint location configuration. |
sellerMetroCode | data[0].zSide.accessPoint.location.metroCode | SV | Metropolitan area identifier. |
- | data[0].zSide.accessPoint.linkProtocol | - | New container object for link protocol configuration. |
- | data[0].zSide.accessPoint.linkProtocol.type | QINQ | New parameter that explicitly specifies the encapsulation standard. |
primaryZSideVlanCTag | data[0].zSide.accessPoint.linkProtocol.vlanCTag | 123 | QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. |
authorizationKey | data[0].zSide.accessPoint.authenticationKey | xx-xxx | Access point authentication key. |
namedTag | data[0].zSide.accessPoint.peeringType | PRIVATE | Access point peering type. Applicable to connections originating from DOT1Q ports. |
- | data[0].notifications | - | New object for email notifications configuration. |
- | data[0].notifications.type | ALL | New parameter enabling differentiation of notifications. |
notifications | data[0].notifications.emails | ["john@equinix.com", "jenkins@equinix.com"] | List of up to 12 recipients. |
- | data[1].type | EVPL_VC | New parameter defining connection type, introduced to support new use cases. EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. |
secondaryName | data[1].name | Connection | Connection name. |
- | data[1].order | - | New container object for order details. |
purchaseOrderNumber | data[1].order.purchaseOrderNumber | 1-129105284100 | Subscriber's purchase order identifier. |
speed | data[1].bandwidth | 1000 | Connection bandwidth. |
speedUnit | - | - | In the v4 API the connection bandwidth is expressed in Mbps. |
- | data[1].redundancy | - | Redundancy details. Not required for primary connections. |
- | data[1].redundancy.group | cea65afb-aa33-a336-2ae0-387a5c00a944 | Unique Id of the redundancy group. This is only required for secondary connections. If you are creating a secondary connection, enter the group of the PRIMARY. You can find the group of the primary connection by calling Get Specified Connection or by checking the response you received in the "group" field at the time of creating primary connection. |
- | data[1].redundancy.priority | SECONDARY | Whether the connection is PRIMARY or SECONDARY. Don't provide a redundancy group Id for a PRIMARY connection. |
- | data[1].aSide | - | New container object for A-side connection configuration. |
- | data[1].aSide.accessPoint | - | New container object for A-side connection access point. |
- | data[1].aSide.accessPoint.type | COLO | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. COLO - Colocation space in an IBX data center. |
- | data[1].aSide.accessPoint.port | - | New container object for A-side port configuration. |
secondaryPortUUID | data[1].aSide.accessPoint.port.uuid | c791f8cb-5904-9040-8ce0-306a5c00a4ee | A-side port identifier. |
- | data[1].aSide.accessPoint.linkProtocol | - | New container object for link protocol configuration. |
- | data[1].aSide.accessPoint.linkProtocol.type | DOT1Q | New parameter that explicitly specifies the encapsulation standard. |
secondaryVlanSTag | data[1].aSide.accessPoint.linkProtocol.vlanTag | 124 | DOT1Q encapsulation VLAN tag. |
- | data[1].zSide | - | New container object for Z-side connection configuration. |
- | data[1].zSide.accessPoint | - | New container object for Z-side connection access point. |
- | data[1].zSide.accessPoint.type | SP | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. SP - Service profile. |
- | data[1].zSide.accessPoint.profile | - | New container object for Z-side service profile configuration. |
profileUUID | data[1].zSide.accessPoint.profile.uuid | c791f8cb-5d01-d010-8ce0-306a5c00a4ee | Z-side profile identifier. |
- | data[1].zSide.accessPoint.location | - | New container object for endpoint location configuration. |
sellerMetroCode | data[1].zSide.accessPoint.location.metroCode | SV | Metropolitan area identifier. |
- | data[1].zSide.accessPoint.linkProtocol | - | New container object for link protocol configuration. |
- | data[1].zSide.accessPoint.linkProtocol.type | QINQ | New parameter that explicitly specifies the encapsulation standard. |
secondaryZSideVlanCTag | data[1].zSide.accessPoint.linkProtocol.vlanCTag | 123 | QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. |
authorizationKey | data[1].zSide.accessPoint.authenticationKey | xx-xxx | Access point authentication key. |
namedTag | data[1].zSide.accessPoint.peeringType | PRIVATE | Access point peering type. Applicable to connections originating from DOT1Q ports. |
- | data[1].notifications | - | New object for email notifications configuration. |
- | data[1].notifications.type | ALL | New parameter enabling differentiation of notifications. |
notifications | data[1].notifications.emails | ["john@equinix.com", "jenkins@equinix.com"] | List of up to 12 recipients. |
Redundant connections to Microsoft Azure ExpressRoute from QINQ ports
v3 request
curl -X
POST 'http://api.equinix.com/ecx/v3/l2/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"primaryName": "JohnDoe_Dot1q_Private",
"profileUUID": "84c6616c-573a-447d-a478-9fab8fff284d",
"speed": 50,
"speedUnit": "MB",
"purchaseOrderNumber": "",
"primaryPortUUID": "7f891d3b-973e-73e0-bae0-30ac1885197a",
"primaryVlanSTag": "458",
"secondaryName": "TestS110",
"secondaryVlanSTag": "442",
"secondaryPortUUID": "7f891d3b-9740-7400-bae0-30ac1885197a",
"namedTag": "Private",
"sellerMetroCode": "SV",
"authorizationKey": "76e781b5-2992-4042-b2a2-37d0d5eb6735",
"notifications": [
"JohnDoe@example.com"
]
}'
v4 request
curl -X
POST 'https: //api.equinix.com/fabric/v4/connections/bulk'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"data": [
{
"type": "EVPL_VC",
"name": "Conn-1",
"order": {
"purchaseOrderNumber": "1-129105284100"
},
"bandwidth": 100,
"redundancy": {
"priority": "PRIMARY"
},
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
},
"linkProtocol": {
"type": "QINQ",
"vlanSTag": 1001
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"profile": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
},
"location": {
"metroCode": "SV",
"region": "us-west-1"
},
"linkProtocol": {
"type": "QINQ"
},
"authenticationKey": "xx-xx-xx",
"peeringType": "PRIVATE"
}
}
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com",
"test1@equinix.com"
]
}
]
},
{
"type": "EVPL_VC",
"name": "Conn-2",
"order": {
"purchaseOrderNumber": "1-129105284100"
},
"bandwidth": 100,
"redundancy": {
"group": "j167f685-41b0-1b07-6de0-320a5c00abie",
"priority": "SECONDARY"
},
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
},
"linkProtocol": {
"type": "QINQ",
"vlanSTag": 1002
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"profile": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
},
"location": {
"metroCode": "SV",
"region": "us-west-1"
},
"linkProtocol": {
"type": "QINQ"
},
"authenticationKey": "xx-xx-xx",
"peeringType": "PRIVATE"
}
}
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com",
"test1@equinix.com"
]
}
]
}
]
}'
v3 API request | v4 API request | Description | |
POST /ecx/v3/l2/connections | POST /fabric/v4/connections/bulk | V4 API introduces a new endpoint dedicated to creating redundant connections. | |
v3 parameter | v4 parameter | Example | Description |
- | data[0].type | EVPL_VC | New parameter defining connection type, introduced to support new use cases. EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. |
primaryName | data[0].name | Connection | Connection name. |
- | data[0].order | - | New container object for order details. |
purchaseOrderNumber | data[0].order.purchaseOrderNumber | 1-129105284100 | Subscriber's purchase order identifier. |
speed | data[0].bandwidth | 1000 | Connection bandwidth. |
speedUnit | - | - | In the v4 API the connection bandwidth is expressed in Mbps. |
- | data[0].redundancy | - | Redundancy details. Not required for PRIMARY connections. |
- | data[0].redundancy.group | cea65afb-aa33-a336-2ae0-387a5c00a944 | Unique Id of the redundancy group. This is only required for secondary connections. If you are creating a secondary connection, enter the group of the PRIMARY. You can find the group of the primary connection by calling Get Specified Connection or by checking the response you received in the "group" field at the time of creating primary connection. |
- | data[0].redundancy.priority | PRIMARY | Whether the connection is PRIMARY or SECONDARY. Don't provide a redundancy group Id for a PRIMARY connection. |
- | data[0].aSide | - | New container object for A-side connection configuration. |
- | data[0].aSide.accessPoint | - | New container object for A-side connection access point. |
- | data[0].aSide.accessPoint.type | COLO | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. COLO - Colocation space in an IBX data center. |
- | data[0].aSide.accessPoint.port | - | New container object for A-side port configuration. |
primaryPortUUID | data[0].aSide.accessPoint.port.uuid | c791f8cb-5904-9040-8ce0-306a5c00a4ee | A-side port identifier. |
- | data[0].aSide.accessPoint.linkProtocol | - | New container object for link protocol configuration. |
- | data[0].aSide.accessPoint.linkProtocol.type | QINQ | New parameter that explicitly specifies the encapsulation standard. |
primaryVlanSTag | data[0].aSide.accessPoint.linkProtocol.vlanSTag | 124 | QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. |
- | data[0].zSide | - | New container object for Z-side connection configuration. |
- | data[0].zSide.accessPoint | - | New container object for Z-side connection access point. |
- | data[0].zSide.accessPoint.type | SP | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. SP - Service profile. |
- | data[0].zSide.accessPoint.profile | - | New container object for Z-side service profile configuration. |
profileUUID | data[0].zSide.accessPoint.profile.uuid | c791f8cb-5d01-d010-8ce0-306a5c00a4ee | Z-side profile identifier. |
- | data[0].zSide.accessPoint.location | - | New container object for endpoint location configuration. |
sellerMetroCode | data[0].zSide.accessPoint.location.metroCode | SV | Metropolitan area identifier. |
- | data[0].zSide.accessPoint.linkProtocol | - | New container object for link protocol configuration. |
- | data[0].zSide.accessPoint.linkProtocol.type | QINQ | New parameter that explicitly specifies the encapsulation standard. |
authorizationKey | data[0].zSide.accessPoint.authenticationKey | xx-xxx | Access point authentication key. |
namedTag | data[0].zSide.accessPoint.peeringType | PRIVATE | Access point peering type. Applicable to connections originating from DOT1Q ports. |
- | data[0].notifications | - | New object for email notifications configuration. |
- | data[0].notifications.type | ALL | New parameter enabling differentiation of notifications. |
notifications | data[0].notifications.emails | ["john@equinix.com", "jenkins@equinix.com"] | List of up to 12 recipients. |
- | data[1].type | EVPL_VC | New parameter defining connection type, introduced to support new use cases. EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. |
secondaryName | data[1].name | Connection | Connection name. |
- | data[1].order | - | New container object for order details. |
purchaseOrderNumber | data[1].order.purchaseOrderNumber | 1-129105284100 | Subscriber's purchase order identifier. |
speed | data[1].bandwidth | 1000 | Connection bandwidth. |
speedUnit | - | - | In the v4 API the connection bandwidth is expressed in Mbps. |
- | data[1].redundancy | - | Redundancy details. Not required for PRIMARY connections. |
- | data[1].redundancy.group | cea65afb-aa33-a336-2ae0-387a5c00a944 | Unique Id of the redundancy group. This is only required for secondary connections. If you are creating a secondary connection, enter the group of the PRIMARY. You can find the group of the primary connection by calling Get Specified Connection or by checking the response you received in the "group" field at the time of creating primary connection. |
- | data[1].redundancy.priority | SECONDARY | Whether the connection is PRIMARY or SECONDARY. Don't provide a redundancy group Id for a PRIMARY connection. |
- | data[1].aSide | - | New container object for A-side connection configuration. |
- | data[1].aSide.accessPoint | - | New container object for A-side connection access point. |
- | data[1].aSide.accessPoint.type | COLO | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. COLO - Colocation space in an IBX data center. |
- | data[1].aSide.accessPoint.port | - | New container object for A-side port configuration. |
secondaryPortUUID | data[1].aSide.accessPoint.port.uuid | c791f8cb-5904-9040-8ce0-306a5c00a4ee | A-side port identifier. |
- | data[1].aSide.accessPoint.linkProtocol | - | New container object for link protocol configuration. |
- | data[1].aSide.accessPoint.linkProtocol.type | QINQ | New parameter that explicitly specifies the encapsulation standard. |
secondaryVlanSTag | data[1].aSide.accessPoint.linkProtocol.vlanSTag | 124 | QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. |
- | data[1].zSide | - | New container object for Z-side connection configuration. |
- | data[1].zSide.accessPoint | - | New container object for Z-side connection access point. |
- | data[1].zSide.accessPoint.type | SP | New parameter defining access point type, introduced to support new access points such as Network Edge virtual devices or Fabric Cloud Router instances. SP - Service profile. |
- | data[1].zSide.accessPoint.profile | - | New container object for Z-side service profile configuration. |
profileUUID | data[1].zSide.accessPoint.profile.uuid | c791f8cb-5d01-d010-8ce0-306a5c00a4ee | Z-side profile identifier. |
- | data[1].zSide.accessPoint.location | - | New container object for endpoint location configuration. |
sellerMetroCode | data[1].zSide.accessPoint.location.metroCode | SV | Metropolitan area identifier. |
- | data[1].zSide.accessPoint.linkProtocol | - | New container object for link protocol configuration. |
- | data[1].zSide.accessPoint.linkProtocol.type | QINQ | New parameter that explicitly specifies the encapsulation standard. |
authorizationKey | data[1].zSide.accessPoint.authenticationKey | xx-xxx | Access point authentication key. |
namedTag | data[1].zSide.accessPoint.peeringType | PRIVATE | Access point peering type. Applicable to connections originating from DOT1Q ports. |
- | data[1].notifications | - | New object for email notifications configuration. |
- | data[1].notifications.type | ALL | New parameter enabling differentiation of notifications. |
notifications | data[1].notifications.emails | ["john@equinix.com", "jenkins@equinix.com"] | List of up to 12 recipients. |