# 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. ![Three steps to connect to IBM Cloud: identify account ID, create connection with Fabric APIs, accept connection](https://docs.equinix.com/assets/images/connectToIbmDirectLink20-d03a5f72aff4e50771a2f6d848d6952d.jpg) ## Identify Your IBM Account ID[​](#identify-your-ibm-account-id "Direct link to Identify Your IBM Account ID") Log in to the [IBM Cloud console](https://cloud.ibm.com/login) and select *Manage* > *Account* to locate your IBM account ID. ## Fabric API Prerequisites[​](#fabric-api-prerequisites "Direct link to Fabric API Prerequisites") 1. Authenticate - Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication. Refer to [API Authentication](https://docs.equinix.com/equinix-api/api-authentication.md) 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](https://docs.equinix.com/api-catalog/fabricv4/ports/getports.md) API request. 3. Choose the Z-side metro location. Use the [Get All Metros](https://docs.equinix.com/api-catalog/fabricv4/metros/getmetros.md) 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](https://docs.equinix.com/api-catalog/fabricv4/service-profiles/searchserviceprofiles.md) API request to search for a specific service profile or use the [List Service Profiles](https://docs.equinix.com/api-catalog/fabricv4/service-profiles/listserviceprofiles.md) API request to list all available service profiles, and identify the profile you want to connect to. ## Connecting to IBM Cloud Direct Link on Classic from a DOT1Q Port[​](#connecting--to-ibm-cloud-direct-link-on-classic-from-a-dot1q-port "Direct link to Connecting to IBM Cloud Direct Link on Classic from a DOT1Q Port") To create a connection from your DOT1Q port to IBM Cloud Direct Link on Classic, send a `POST` request to the [`/fabric/v4/connections`](https://docs.equinix.com/api-catalog/fabricv4/connections/createconnection.md) endpoint. Specify your connection's configuration details in the body of the request. | | **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`, `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 ' -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](https://docs.equinix.com/api-catalog/fabricv4/connections/createconnection.md). 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](https://docs.equinix.com/api-catalog/fabricv4/connections/createconnection.md). ## Connecting to IBM Cloud Direct Link on Classic from a QINQ port[​](#connecting-to-ibm-cloud-direct-link-on-classic-from-a-qinq-port "Direct link to Connecting to IBM Cloud Direct Link on Classic from a QINQ port") To create a connection from your QINQ port to IBM Cloud Direct Link on Classic, send a `POST` request to the [`/fabric/v4/connections`](https://docs.equinix.com/api-catalog/fabricv4/connections/createconnection.md) 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 ' -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](https://docs.equinix.com/api-catalog/fabricv4/connections/createconnection.md). ## Monitoring Connection Status[​](#monitoring-connection-status "Direct link to Monitoring Connection Status") Send a `GET` request to the [`fabric/v4/connections/{connectionId}`](https://docs.equinix.com/api-catalog/fabricv4/connections/getconnectionbyuuid.md) endpoint to monitor connection status. | `equinixStatus`attribute values | `providerStatus`attribute values | **IBM Direct Link** status | **Description** | | ------------------------------- | -------------------------------- | -------------------------- | ------------------------------------------------ | | `PROVISIONING` | `PROVISIONING` | - | Connection request has not been sent to IBM yet. | | `PENDING_PROVIDER_VLAN` | `PENDING_APPROVAL` | Create approval pending | The connection awaits for approval. | | `PROVISIONED` | `PROVISIONING / PROVISIONED` | Create in progress | Connection establishment in progress. | | `PROVISIONED` | `PROVISIONED` | Provisioned | Connection established. | ## Accepting the Connection[​](#accepting-the-connection "Direct link to Accepting the Connection") Log in to the [IBM Cloud console](https://cloud.ibm.com/login) and go to the [IBM Cloud Direct Link Exchange page](https://cloud.ibm.com/classic/network/directlink/exchange) to review and accept the pending connection.