Skip to main content

API - Connect to IBM Cloud Direct Link on Classic

Establish a connection with IBM Cloud™ Direct Link on Classic to connect your IBX colocated assets to your IBM Cloud resources.

Identify Your IBM Account ID

Log in to the IBM Cloud console and select Manage > Account to locate your IBM account ID.

Fabric API 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 OAuth API to validate and authenticate your credentials.

  2. Determine Your A-side Information. Retrieve your Equinix Fabric ports information using the Get All Ports API request.

  3. Choose the Z-side metro location. Use the Get All Metros API request to find all metros where Equinix Fabric is available and determine destination location.

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

To create a connection from your DOT1Q port to IBM Cloud Direct Link on Classic, 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, bandwidth, redundancy, aSide, zSide, additionalInfo, 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": {
        "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"
            },
            "authenticationKey": "xx-xxx-xx",
            "sellerRegion": "us-west-1"
        }
    },
    "additionalInfo": [
        {
            "key": "ASN",
            "value": "12345"
        },
        {
            "key": "Global",
            "value": "false"
        }
    ],
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com",
                "test2@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": "m167f685-41b0-1b07-6de0-320a5c00abeu",
        "priority": "PRIMARY"
    },
    "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/services/serviceProfiles/20d32a80-0d61-4333-bc03-707b591ae2f5",
                "type": "L2_PROFILE",
                "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
            },
            "location": {
                "href": "https://api.equinix.com/v4/metros/SV",
                "metroCode": "SV",
                "region": "AMER"
            },
            "sellerRegion": "us-west-1"
        }
    },
    "additionalInfo": [
        {
            "key": "ASN",
            "value": "12345"
        },
        {
            "key": "Global",
            "value": "false"
        }
    ],
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com",
                "test2@equinix.com"
            ]
        }
    ],
    "operation": {
        "equinixStatus": "PROVISIONING",
        "providerStatus": "PROVISIONING"
    },
    "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.

To create a connection from your QINQ port to IBM Cloud Direct Link on Classic, send a POST request to the /fabric/v4/connections endpoint. Specify your connection's configuration details in the body of the 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": {
        "priority": "PRIMARY"
    },
    "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"
            },
            "authenticationKey": "xx-xxx-xx",
            "sellerRegion": "us-west-1"
        }
    },
    "additionalInfo": [
        {
            "key": "ASN",
            "value": "12345"
        },
        {
            "key": "Global",
            "value": "false"
        }
    ],
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com",
                "test2@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 Connection Status

Send a GET request to the fabric/v4/connections/{connectionId} endpoint to monitor connection status.

equinixStatusattribute valuesproviderStatusattribute valuesIBM Direct Link statusDescription
PROVISIONINGPROVISIONING-Connection request has not been sent to IBM yet.
PENDING_PROVIDER_VLANPENDING_APPROVALCreate approval pendingThe connection awaits for approval.
PROVISIONEDPROVISIONING / PROVISIONEDCreate in progressConnection establishment in progress.
PROVISIONEDPROVISIONEDProvisionedConnection established.

Accepting the Connection

Log in to the IBM Cloud console and navigate to the IBM Cloud Direct Link Exchange page to review and accept the pending connection.