Connect Network Edge Device to Remote Port

Establish an untagged connection between your Network Edge virtual device and a remote Fabric Port using the Fabric API.

Fabric API Prerequisites

Authenticate - Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication. Refer to API Authentication for instructions on how to call OAuth API to validate and authenticate your credentials.
Determine Your A-side Information. Retrieve your Network Edge devices information using the Get Virtual Devices or Get Virtual Device {uuid}. You may choose any available interface on the device for your connection. However, Equinix will select an interface if you do not specify one.
Retrieve your Equinix Fabric ports information using the Get All Ports API request.

Connecting to an Untagged Remote Port

To create a connection from a Network Edge device to a remote port with untagged traffic, send a POST request to the /fabric/v4/connections endpoint. Specify your connection's configuration details in the body of the request.

note

You can create only a single untagged connection from a Network Edge virtual device to a remote port.

	POST /fabric/v4/connections
Method	`POST`
Endpoint	`/fabric/v4/connections`
Headers	`Authorization`, `Content-Type`
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	`type`, `name`, `order`, `bandwidth`, `aSide`, `zSide`, `project`, `notifications`

Sample cURL Request:

curl -X  
POST 'https://api.equinix.com/fabric/v4/connections'  
-H 'content-type: application/json'  
-H 'authorization: Bearer <token>'  
-d '{  
    "type": "EVPL_VC",  
    "bandwidth": 100,  
    "redundancy": {  
        "priority": "PRIMARY"  
    },  
    "name": "ConnectionName-1",  
    "order": {  
        "purchaseOrderNumber": "1-3232923"  
    },  
    "aSide": {  
        "accessPoint": {  
            "type": "VD",  
            "virtualDevice": {  
                "type": "EDGE",  
                "uuid": "fd5342f3-d067-4683-a24f-be952279630b"  
            },  
            "interface": {  
                "type": "NETWORK",  
                "id": 45645  
            }  
        }  
    },  
    "zSide": {  
        "accessPoint": {  
            "type": "COLO",  
            "port": {  
                "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"  
            },  
            "linkProtocol": {  
                "type": "UNTAGGED"  
            }  
        }  
    },  
    "project": {  
        "projectId": 567  
    },  
    "notifications": [  
        {  
            "type": "ALL",  
            "emails": [  
                "test@equinix.com",  
                "test1@equinix.com"  
            ]  
        }  
    ]  
}'

The parameters included in the request body are specific to this example. For a full list of parameters and their descriptions, see the API Reference.

Connecting to a DOT1Q Remote Port

To create a connection from a Network Edge device to a DOT1Q remote port, send a POST request to the /fabric/v4/connections endpoint. Specify your connection's configuration details in the body of the request.

Sample cURL Request:

curl -X  
POST 'https://api.equinix.com/fabric/v4/connections'  
-H 'content-type: application/json'  
-H 'authorization: Bearer <token>'  
-d '  
{  
    "type": "EVPL_VC",  
    "bandwidth": 1000,  
    "name": "vd to COLO",  
    "aSide": {  
    "accessPoint": {  
        "type": "VD",  
        "virtualDevice": {  
        "type": "EDGE",  
        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"  
        },  
        "interface": {  
        "type": "NETWORK",  
        "id": 45645  
        }  
    }  
    },  
    "zSide": {  
    "accessPoint": {  
        "type": "COLO",  
        "port": {  
        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"  
        },  
        "linkProtocol": {  
        "type": "DOT1Q",  
        "vlanTag": 300  
        }  
    }  
    },  
    "order": {  
    "purchaseOrderNumber": "1-129105284100"  
    },  
    "notifications": [  
    {  
        "type": "ALL",  
        "emails": [  
        "test@equinix.com",  
        "test1@equinix.com"  
        ]  
    }  
    ]  
}'

Sample Response:

{  
    "type": "EVPL_VC",  
    "href": "https://api.equinix.com/fabric/v4/connections/c193c1c4-2c7e-472d-8c91-0283bc3b5a71",  
    "uuid": "c193c1c4-2c7e-472d-8c91-0283bc3b5a71",  
    "name": "ConnectionName-1",  
    "state": "PROVISIONING",  
    "operation": {  
        "providerStatus": "NOT_AVAILABLE",  
        "equinixStatus": "PROVISIONING"  
    },  
    "order": {  
        "purchaseOrderNumber": "1-3232923"  
    },  
    "project": {  
        "projectId": 567  
    },  
    "notifications": [  
        {  
            "type": "ALL",  
            "emails": [  
                "testqq@equinix.com"  
            ]  
        }  
    ],  
    "account": {  
        "accountNumber": 270217,  
        "orgId": 92287,  
        "globalOrgId": "0016u000003JZ53AAG"  
    },  
    "changeLog": {  
        "createdBy": "eqxnfvuser",  
        "createdDateTime": "2022-03-22T23:14:23.546Z"  
    },  
    "bandwidth": 100,  
    "redundancy": {  
        "group": "79a0e626-55fe-4fe1-89a5-4d7ca52214db",  
        "priority": "PRIMARY"  
    },  
    "isRemote": true,  
    "direction": "INTERNAL",  
    "aSide": {  
        "accessPoint": {  
            "interface": {  
                "uuid": "bf8a606b-32b2-4a53-a450-6eabd7d9ccab",  
                "id": 45645,  
                "type": "CLOUD"  
            },  
            "type": "VD",  
            "account": {  
                "accountNumber": 270217,  
                "orgId": 92287,  
                "organizationName": "eqx-nfv",  
                "globalOrgId": "0016u000003JZ53AAG"  
            },  
            "location": {  
                "href": "https://api.equinix.com/fabric/v4/metros/DC",  
                "region": "AMER",  
                "metroName": "Ashburn",  
                "metroCode": "DC"  
            },  
            "virtualDevice": {  
                "href": "https://api.equinix.com/ne/v1/devices/fd5342f3-d067-4683-a24f-be952279630b",  
                "uuid": "fd5342f3-d067-4683-a24f-be952279630b",  
                "name": "ha-json",  
                "type": "EDGE"  
            }  
        }  
    },  
    "zSide": {  
        "accessPoint": {  
            "type": "COLO",  
            "account": {  
                "accountNumber": 270224,  
                "orgId": 92287,  
                "organizationName": "eqx-nfv",  
                "globalOrgId": "0016u000003JZ53AAG"  
            },  
            "location": {  
                "href": "https://api.equinix.com/fabric/v4/metros/SY",  
                "region": "APAC",  
                "metroName": "Sydney",  
                "metroCode": "SY"  
            },  
            "port": {  
                "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-5d73-d730-8ce0-306a5c00a4ee",  
                "uuid": "c791f8cb-5d73-d730-8ce0-306a5c00a4ee",  
                "name": "eqx-nfv-SY1-L-Dot1q-BO-PRI-10G-JN-1147"  
            },  
            "linkProtocol": {  
                "type": "DOT1Q"  
            }  
        }  
    },  
    "additionalInfo": []  
}

Response payload includes configuration parameters defined in the request body. For a full list of possible parameters and their descriptions, see the API Reference.

Connecting to a QinQ Remote Port

To create a connection from a Network Edge device to a QinQ remote port, send a POST request to the /fabric/v4/connections endpoint. Specify your connection's configuration details in the body of the request.

Sample cURL Request:

curl -X  
POST 'https://api.equinix.com/fabric/v4/connections'  
-H 'content-type: application/json'  
-H 'authorization: Bearer <token>'  
-d '  
{  
    "type": "EVPL_VC",  
    "bandwidth": 1000,  
    "name": "vd to COLO",  
    "aSide": {  
    "accessPoint": {  
        "type": "VD",  
        "virtualDevice": {  
        "type": "EDGE",  
        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"  
        },  
        "interface": {  
        "type": "NETWORK",  
        "id": 45645  
        }  
    }  
    },  
    "zSide": {  
    "accessPoint": {  
        "type": "COLO",  
        "port": {  
        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"  
        },  
        "linkProtocol": {  
        "type": "QINQ",  
        "vlanSTag": 300,  
        "vlanCTag": 400  
        }  
    }  
    },  
    "order": {  
    "purchaseOrderNumber": "1-129105284100"  
    },  
    "notifications": [  
    {  
        "type": "ALL",  
        "emails": [  
        "test@equinix.com",  
        "test1@equinix.com"  
        ]  
    }  
    ]  
}  
'

Monitoring Your Connection

Use the Get Specified Connection API endpoint to monitor connection status.

Fabric API Prerequisites​

Connecting to an Untagged Remote Port​

Connecting to a DOT1Q Remote Port​

Connecting to a QinQ Remote Port​

Monitoring Your Connection​

Fabric API Prerequisites

Connecting to an Untagged Remote Port

Connecting to a DOT1Q Remote Port

Connecting to a QinQ Remote Port

Monitoring Your Connection