Skip to main content

Connect to a Service Provider on Fabric

Establish a connection between your IBX colocated assets and a service profile.

Prerequisites

  1. Authenticate - Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication. Refer to API Authentication for instructions on how to call the OAuth API to validate and authenticate your credentials.

  2. Determine A-side port information. Get your relevant port information using the Get All Ports endpoint.

  3. Choose the z-side Metro location. Use the Get All Metros endpoint to find all metros where Equinix Fabric is available and determine your connection's destination location.

  4. Identify the service provider's service profile information. Use the Retrieve Service Profiles endpoint to search for a specific service profile or use the Get Service Profiles endpoint to list all available service profiles, and identify the profile you want to connect to.

Creating a Connection from a DOT1Q port to a Service Provider

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

POST /fabric/v4/connections
MethodPOST
Endpoint/fabric/v4/connections
HeadersAuthorization, Content-Type
Path ParametersNot applicable
Query ParametersNot applicable
Body Parameterstype, name, order, redundancy, bandwidth, aSide, zSide, 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",
    "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"
            ]
        }
    ]
}'

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.

Sample Response:

{  
"href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"type": "EVPL_VC",
"uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"name": "Conn-1",
"state": "PROVISIONING",
"order": {
    "purchaseOrderNumber": "1-129105284100",
    "billingTier": "Up to 1 Gbps"
},
"bandwidth": 1000,
"redundancy": {
    "group": "b767f685-41b0-1b07-6de0-320a5c00abdd",
    "priority": "SECONDARY"
},
"aSide": {
    "accessPoint": {
        "type": "COLO",
        "port": {
            "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
            "type": "XF_PORT",
            "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
        },
        "linkProtocol": {
            "type": "DOT1Q",
            "vlanTag": 1001
        }
    }
},
"zSide": {
    "accessPoint": {
        "type": "SP",
        "profile": {
            "href": "https://api.equinix.com/fabric/v4/serviceProfiles/a867f685-41b0-1b07-6de0-320a5c00abdd",
            "type": "L2_Profile",
            "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
        },
        "location": {
            "href": "https://api.equinix.com/v4/metros/SV",
            "metrocode": "SV",
            "region": "AMER"
        }
    }
},
"notifications": [
    {
        "type": "ALL",
        "emails": [
            "test@equinix.com",
            "test2@equinix.com"
        ]
    }
],
"operation": {
    "equinixStatus": "PENDING_APPROVAL",
    "providerStatus": "NOT_AVAILABLE"
},
"changeLog": {
    "createdDateTime": "2021-07-15T19:30:29.526Z"
}
}

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

Creating a Connection from a QINQ port to a Service Provider

To create a connection from a QINQ port to a Service Provider 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",
    "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"
            ]
        }
    ]
}'

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.

Monitoring the Connection

Use the Get Specified Connection endpoint to monitor connection status.

equinixStatus parameter valuesproviderStatus parameter valuesDescription
PENDING_APPROVALNOT_AVAILABLEConnection request awaiting approval.
PROVISIONING or REJECTEDNOT_AVAILABLEConnection establishment in progress or the seller has rejected the connection.
PROVISIONEDAVAILABLEConnection established.