Connect as E-access

Enable access to your network services over Equinix Fabric without having to manage connections' C-tag information.

nonRedundantSelfConnectionOverview_0

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

Retrieve your Equinix Fabric ports information using the Get All Ports API request.

The port that aggregates traffic from different clients must use QINQ encapsulation
The port that aggregates traffic from different clients can be assigned to other ACCESS_EPL_VC type connections only
The client's side port must be an EPL port and it can't be assigned to any other connection unless it's in the DEPROVISIONED state

Step 3: Create Connection

Use the POST /fabric/v4/connections API request to create a connection with the pre-determined attributes.

	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, redundancy, bandwidth, aSide, zSide, project, notifications

The POST Connections API request creates a layer 2 connection between two ports in IBX data centers colocation space.

Use the Retrieve Pricing API request to retrieve connection price estimate.

Sample curl request - QINQ port to EPL port connection

curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "ACCESS_EPL_VC",
    "name": "Conn-1",
    "order": {
        "purchaseOrderNumber": "1-129105284100"
    },
    "bandwidth": 50,
    "redundancy": {
        "priority": "PRIMARY"
    },
    "aSide": {
        "accessPoint": {
            "type": "COLO",
            "port": {
                "uuid": "3312101f-5bd0-43d5-b21a-d442b35816a5"
            },
            "linkProtocol": {
                "type": "QINQ",
                "vlanSTag": 1001
            }
        }
    },
    "zSide": {
        "accessPoint": {
            "type": "COLO",
            "port": {
                "uuid": "ca655bb1-cca0-ca01-75e0-306a5c00ae38"
            }
        }
    },
    "project": {  
        "projectId": 568
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com"
            ]
        }
    ]
}'

Sample curl request - EPL port to QINQ port connection

curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "ACCESS_EPL_VC",
    "name": "Conn-1",
    "order": {
        "purchaseOrderNumber": "1-129105284100"
    },
    "bandwidth": 50,
    "redundancy": {
        "priority": "PRIMARY"
    },
    "aSide": {
        "accessPoint": {
            "type": "COLO",
            "port": {
                "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
            }
        }
    },
    "zSide": {
        "accessPoint": {
            "type": "COLO",
            "port": {
                "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
            },
            "linkProtocol": {
                "type": "QINQ",
                "vlanSTag": 1001
            }
        }
    },
    "project": {  
        "projectId": 568
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com",
                "test@equinix.com"
            ]
        }
    ]
}'

Body parameters

Parameter	Mandatory	Type	Example values	Applicable values	Description
type	yes	string	ACCESS_EPL_VC	ACCESS_EPL_VC	Connection type. ACCESS_EPL_VC - E-access, layer 2 connection between a QINQ port and an EPL port.
name	yes	string	Conn-1	Maximum: 24 characters Allowed characters: alpha-numeric, hyphens ('-') and underscores ('_')	Connection name.
order	no	object	-	-	Order details.
bandwidth	yes	integer	1000	Maximum: cannot exceed port bandwidth.	Connection bandwidth in Mbps.
redundancy	Conditional	object	-	-	Redundancy details. Required for secondary connections.
aSide	yes	object	-	-	Source port definition.
zSide	yes	object	-	-	Destination port definition.
project	no	object	-	-	Customer project information.
notifications	yes	array[object]	-	-	Subscriber preferences for notification of changes in asset configuration or status.

order
purchaseOrderNumber	no	string	1-129105284100	-	Subscriber's purchase order identifier.

redundancy
group	Conditional	string	5c0e9384-aa79-4ec9-b7a2-557f8c307292	-	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 "group" field in the response you receive when creating primary connection.
priority	Conditional	string	PRIMARY	PRIMARY SECONDARY	Whether the connection is PRIMARY or SECONDARY. Don't provide a redundancy group for a PRIMARY connection.

aSide/zSide
accessPoint	yes	object	-	-	Connection endpoint configuration.

aSide/zSide.accessPoint
type	yes	string	COLO	COLO	Connection endpoint type. COLO - Colocation space in an IBX data center.
port	yes	object	-	-	Port associated with the connection.
linkProtocol	yes	object	-	-	Link protocol configuration.

aSide/zSide.accessPoint.port
uuid	yes	string	a867f685-41b0-1b07-6de0-320a5c00abdd	-	Equinix-assigned port identifier.

aSide/zSide.accessPoint.linkProtocol
type	yes	string	QINQ	QINQ	Link protocol type.
vlanSTag	yes	integer	1003	Range: 2-4094	QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines.

project
projectId	no	integer	568	-	Customer project identifier.

notifications
type	yes	string	ALL	ALL	Notification preferences for a specified asset.
emails	yes	array[string]	["john@equinix.com", "jenkins@equinix.com"]	Minimum: 1 Maximum: 12	List of up to 12 recipients.

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response - QINQ port to EPL port connection

{
    "type": "ACCESS_EPL_VC",
    "href": "https://api.equinix.com/fabric/v4/connections/eb45d323-5281-44dc-842b-c19a15ac837f",
    "uuid": "eb45d323-5281-44dc-842b-c19a15ac837f",
    "name": "Conn-1",
    "state": "PROVISIONING",
    "operation": {
        "providerStatus": "NOT_AVAILABLE",
        "equinixStatus": "PROVISIONING"
    },
    "order": {
        "purchaseOrderNumber": "1-129105284100",
        "billingTier": "Up to 50 Mbps"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com"
            ]
        }
    ],
    "project": {  
        "projectId": 568
    },
    "account": {
        "accountNumber": 272235,
        "orgId": 91604,
        "globalOrgId": "0016u000003JZ6HAAW"
    },
    "changeLog": {
        "createdBy": "EPL-account01-user",
        "createdDateTime": "2022-03-26T11:07:47.325Z"
    },
    "bandwidth": 50,
    "redundancy": {
        "group": "5c0e9384-aa79-4ec9-b7a2-557f8c307292",
        "priority": "PRIMARY"
    },
    "isRemote": false,
    "direction": "INTERNAL",
    "aSide": {
        "accessPoint": {
            "type": "COLO",
            "account": {
                "accountNumber": 272235,
                "orgId": 91604,
                "organizationName": "EPL-account01",
                "globalOrgId": "0016u000003JZ6HAAW"
            },
            "location": {
                "href": "https://api.equinix.com/fabric/v4/metros/DA",
                "region": "AMER",
                "metroName": "Dallas",
                "metroCode": "DA"
            },
            "port": {
                "href": "https://api.equinix.com/fabric/v4/ports/3312101f-5bd0-43d5-b21a-d442b35816a5",
                "uuid": "3312101f-5bd0-43d5-b21a-d442b35816a5",
                "name": "272235-DA1-CX-Primary-01"
            },
            "linkProtocol": {
                "type": "QINQ",
                "vlanSTag": 689,
                "vlanCTag": 0
            }
        }
    },
    "zSide": {
        "accessPoint": {
            "type": "COLO",
            "account": {
                "accountNumber": 272235,
                "orgId": 91604,
                "organizationName": "EPL-account01",
                "globalOrgId": "0016u000003JZ6HAAW"
            },
            "location": {
                "href": "https://api.equinix.com/fabric/v4/metros/DA",
                "region": "AMER",
                "metroName": "Dallas",
                "metroCode": "DA"
            },
            "port": {
                "href": "https://api.equinix.com/fabric/v4/ports/ca655bb1-cca0-ca01-75e0-306a5c00ae38",
                "uuid": "ca655bb1-cca0-ca01-75e0-306a5c00ae38",
                "name": "EPL-account01-DA1-NL-EPL-STD-SEC-10G-NK-28"
            },
            "linkProtocol": {
                "type": "UNTAGGED"
            }
        }
    }
}

Response payload body description

Response payload includes configuration parameters defined in the request body. The following table contains descriptions of additional information included in the response payload. For descriptions of the remaining fields, refer to the Body parameters section.

Field	Type	Example values	Description
href	string	https://api.equinix.com/fabric/v4/connections/ 3a58dd05-f46d-4b1d-a154-2e85c396ea62	An absolute URL that returns the specified connection.
uuid	string	3a58dd05-f46d-4b1d-a154-2e85c396ea62	Equinix-assigned connection identifier.
state	string	PROVISIONING	Lifecycle stage of a connection.
operation	object	-	Connection operational data.
order	object	-	Order details.
redundancy	object	-	Redundancy details.
account	object	-	Account information.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
aSide	object	-	Source port definition.
zSide	object	-	Destination port definition.

operation
equinixStatus	string	PROVISIONING	Progress towards provisioning a specified connection.
providerStatus	string	NOT_AVAILABLE	Provider's progress towards provisioning a specified connection.

order
billingTier	string	Up to 50 Mbps	Billing tier for connection bandwidth.

redundancy
group	string	7a58dd05-f46d-4b1d-a154-2e85c396ea63	Unique Id of the redundancy group.
priority	string	PRIMARY	Whether the connection is PRIMARY or SECONDARY.

account
accountNumber	integer	270217	Equinix-assigned account number.
orgId	integer	92832	Equinix-assigned organization identifier.
organizationName	string	EPL-account01	Customer organization name.
globalOrgId	string	0016u000003JZ53AAG	Equinix-assigned top-level organization identifier associated with the specified asset.

changeLog
createdDateTime	string	2021-07-15T19:30:29.526Z	Connection creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

aSide/zSide
accessPoint	object	-	Connection endpoint configuration.

aSide/zSide.accessPoint
account	object	-	Account information.
location	object	-	Geographic attributes of the specified access point.
port	object	-	Port associated with the connection.

aSide/zSide.accessPoint.location
href	string	https://api.equinix.com/fabric/v4/metros/DA	An absolute URL that returns complete specification for the selected metro.
region	string	AMER	Broad geographic area in which a specified Equinix asset is located.
metroName	string	Dallas	Metropolitan area name.
metroCode	string	DA	Metropolitan area identifier.

aSide/zSide.accessPoint.port
href	string	https://api.equinix.com/fabric/v4/ports/ a867f685-41b0-1b07-6de0-320a5c00abdd	An absolute URL that returns the specified port.
name	string	272235-DA1-CX-Primary-01	Equinix-assigned port name.

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

Step 1: Authenticate​

Step 2: Get Attribute Information​

Step 3: Create Connection​

Step 1: Authenticate

Step 2: Get Attribute Information

Step 3: Create Connection