Connect to an Enterprise - Parameters Mapping

Connection from a DOT1Q port to a third-party based on a service profile
Connection from a QINQ port to a third-party based on a service profile

Connection from a DOT1Q port to a third-party based on a service profile with a DOT1Q port

v3 request

curl -X
POST 'https://api.equinix.com/ecx/v3/l2/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "primaryName": "JohnDoe_Dot1Q_To_Dot1Q",
    "profileUUID": "8e79b5e4-7c5b-4201-9334-fd89b37bec47",
    "speed": 50,
    "speedUnit": "MB",
    "notifications": [
        "JohnDoe@example.com"
    ],
    "purchaseOrderNumber": "1234567890",
    "authorizationKey": "xxxxxxxx",
    "primaryPortUUID": "4f891d3b-973e-73e0-bae0-30ac1885197a",
    "primaryVlanSTag": "672",
    "sellerMetroCode": "DA"
}'

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": {
        "group": "b767f685-41b0-1b07-6de0-320a5c00abdd",
        "priority": "SECONDARY"
    },
    "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"
            }
        }
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com",
                "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 service profile identifier.
-	zSide.accessPoint.location	-	New container object for endpoint location configuration.
sellerMetroCode	zSide.accessPoint.location.metroCode	SV	Metropolitan area identifier.
-	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.

Connection from a QINQ port to a third-party based on a service profile with a DOT1Q port

v3 request

curl -X
POST "https://api.equinix.com/ecx/v3/l2/connections"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
    "primaryName": "JohnDoe_QinQ_To_Dot1Q",
    "profileUUID": "2a73af1a-3c74-47ac-b778-6bf455d1174e",
    "speed": 50,
    "speedUnit": "MB",
    "notifications": [
        "JohnDoe@example.com"
    ],
    "purchaseOrderNumber": "1234567890",
    "authorizationKey": "xxxxxxxx",
    "primaryPortUUID": "6f891d3b-972d-73d0-bae3-30ac1995197a",
    "primaryVlanSTag": "470",
    "primaryVlanCTag": "470",
    "sellerMetroCode": "DA"
}'

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": {
        "group": "b767f685-41b0-1b07-6de0-320a5c00abdd",
        "priority": "SECONDARY"
    },
    "aSide": {
        "accessPoint": {
            "type": "COLO",
            "port": {
                "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
            },
            "linkProtocol": {
                "type": "QINQ",
                "vlanCTag": 1001,
                "vlanSTag": 1002
            }
        }
    },
    "zSide": {
        "accessPoint": {
            "type": "SP",
            "profile": {
                "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
            },
            "location": {
                "metroCode": "SV"
            }
        }
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com",
                "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.
primaryVlanCTag	aSide.accessPoint.linkProtocol.vlanCTag	125	QINQ protocol, inner virtual local area network (VLAN) customer 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.
-	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.