# API - Connect to Google Cloud Platform Establish a direct, layer 2 connection to Google Cloud Partner Interconnect using a Fabric Port, Fabric Cloud Router, or service token. ![Three steps to connect to Google Cloud: retrieve pairing key, create connection with Fabric APIs, activate connection](https://docs.equinix.com/assets/images/connectToGoogle-73a150d957737a8b28aab08b1ac4127d.png) > **Note** > > For instructions on connecting from a Network Edge virtual device, see [Network Edge to Google Cloud Platform](https://docs.equinix.com/fabric-marketplace/connecting-to-service-provider/gcp/fabric-gcp-googleqc.md). ## Prerequisites[​](#prerequisites "Direct link to 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. Either: * Retrieve your Equinix Fabric ports information using the [Get All Ports](https://docs.equinix.com/api-catalog/fabricv4/ports/getports.md) API request. OR * Determine your Fabric Cloud Router information. Check your available cloud routers by sending a `POST` request to the [`/fabric/v4/routers/search`](https://docs.equinix.com/api-catalog/fabricv4/cloud-routers/searchcloudrouters.md) endpoint. You need the router's UUID. OR * Retrieve your a-side service token or tokens by sending a `GET` request to the [`/fabric/v4/serviceTokens`](https://docs.equinix.com/api-catalog/fabricv4/#tag/Service-Tokens/operation/getServiceTokens) endpoint. You need the token's UUID. The a-side token provides the relevant information to configure the a-side of the connection. 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 Google Cloud Partner Interconnect service profile information. More information on which service profile you should choose is on the [Overview](https://docs.equinix.com/fabric-marketplace/connecting-to-service-provider/gcp/gcp-interconnect-overview.md#redundancy-and-service-profiles) page. * Zone 1 - `bd4570e2-d792-4a00-87f5-3bde040cdcd7` * Zone 2 - `b97dacca-abe6-4e8c-8be1-fcdd1be1defe` 5. Validate your Authorization Key. Send a `POST` request to the [`/fabric/v4/connections/validate`](https://docs.equinix.com/api-catalog/fabricv4/connections/validateconnections.md) endpoint to verify that your pairing key can be used to create a connection to the selected service profile in the given metro. ## Connecting from a DOT1Q port[​](#connecting-from-a-dot1q-port "Direct link to Connecting from a DOT1Q port") To create a connection from your DOT1Q port to Google Cloud Partner Interconnect, send a `POST` request to the [`/fabric/v4/connections`](https://docs.equinix.com/api-catalog/fabricv4/connections/createconnection.md) endpoint. The connection `type` is `EVPL_VC`. Provide your port information in the `aSide` object including: * `accessPoint.type` as `COLO` * Provide your port's UUID to `port.uuid` * Set `linkProtocol.type` as `DOT1Q` * Provide the VLAN ID to `linkProtocol.vlanTag` Provide your GCP details and location details in the `zSide` object including: * Set `accessPoint.type` as `SP`. * Set `profile.type` as `L2_PROFILE`. * Specify the service profile you are connecting to in `profile.uuid`. * Specify the Equinix Metro location you are connecting to in `location.metroCode`. * Set `authenticationKey` as your Google Cloud-issued pairing key. Ensure that: * If you are creating a connection where the `redundancy` is `PRIMARY` that the pairing key ends in `/1` and you are using the Google Cloud Partner Interconnect Zone 1 service profile UUID `bd4570e2-d792-4a00-87f5-3bde040cdcd7`. * If you are creating a connection where the `redundancy` is `SECONDARY` that the pairing key ends in `/2` and you are using the Google Cloud Partner Interconnect Zone 2 service profile UUID `b97dacca-abe6-4e8c-8be1-fcdd1be1defe`. * If you are creating redundant connections, send two API requests, one for each redundancy priority. Specify any other connection configuration details, in the body of the request. For a full list of parameters and their descriptions, see the [API Reference](https://docs.equinix.com/api-catalog/fabricv4/connections/createconnection.md). Sample cURL Request: ``` POST 'https://api.equinix.com/fabric/v4/connections' -H 'content-type: application/json' -H 'authorization: Bearer ' -d '{ "type": "EVPL_VC", "name": "", "bandwidth": , "redundancy": { "priority": "" }, "aSide": { "accessPoint": { "type": "COLO", "port": { "uuid": "" }, "linkProtocol": { "type": "DOT1Q", "vlanTag": } } }, "zSide": { "accessPoint": { "type": "SP", "profile": { "uuid": "" }, "location": { "metroCode": "" }, "authenticationKey": "", "sellerRegion": "" } }, "order": { "purchaseOrderNumber": "" }, "notifications": [ { "type": "ALL", "emails": [ "", "" ] } ] }' ``` ## Connecting from a QINQ Port[​](#connecting-from-a-qinq-port "Direct link to Connecting from a QINQ Port") To create a connection from your QINQ port to Google Cloud Partner Interconnect, send a `POST` request to the [`/fabric/v4/connections`](https://docs.equinix.com/api-catalog/fabricv4/connections/createconnection.md) endpoint. The connection `type` is `EVPL_VC`. Provide your port information in the `aSide` object including: * `accessPoint.type` as `COLO` * Provide your port's UUID to `port.uuid` * Set `linkProtocol.type` as `QINQ` * Provide the inner tag ID to `linkProtocol.vlanCTag` * Provide the outer tag ID to `linkProtocol.vlanSTag` Provide your GCP details and location details in the `zSide` object including: * Set `accessPoint.type` as `SP`. * Set `profile.type` as `L2_PROFILE`. * Specify the service profile you are connecting to in `profile.uuid`. * Specify the Equinix Metro location you are connecting to in `location.metroCode`. * Set `authenticationKey` as your Google Cloud-issued pairing key. Ensure that: * If you are creating a connection where the `redundancy` is `PRIMARY` that the pairing key ends in `/1` and you are using the Google Cloud Partner Interconnect Zone 1 service profile UUID `bd4570e2-d792-4a00-87f5-3bde040cdcd7`. * If you are creating a connection where the `redundancy` is `SECONDARY` that the pairing key ends in `/2` and you are using the Google Cloud Partner Interconnect Zone 2 service profile UUID `b97dacca-abe6-4e8c-8be1-fcdd1be1defe`. * If you are creating redundant connections, send two API requests, one for each redundancy priority. Specify any other connection configuration details, in the body of the request. For a full list of parameters and their descriptions, see the [API Reference](https://docs.equinix.com/api-catalog/fabricv4/connections/createconnection.md). Sample cURL Request: ``` POST 'https://api.equinix.com/fabric/v4/connections' -H 'content-type: application/json' -H 'authorization: Bearer ' -d '{ "type": "EVPL_VC", "name": "", "bandwidth": "redundancy": { "priority: "" }, "aSide": { "accessPoint": { "type": "COLO", "port": { "uuid": "" }, "linkProtocol": { "type": "QINQ", "vlanCTag": , "vlanSTag": } } }, "zSide": { "accessPoint": { "type": "SP", "profile": { "uuid": "" }, "location": { "metroCode": "" }, "authenticationKey": "", "sellerRegion": "" } }, "order": { "purchaseOrderNumber": "" }, "notifications": [ { "type": "ALL", "emails": [ "", "" ] } ] }' ``` ## Connecting from a Fabric Cloud Router[​](#connecting-from-a-fabric-cloud-router "Direct link to Connecting from a Fabric Cloud Router") To create a connection from your Fabric Cloud Router to AWS, send a `POST` request to the [`/fabric/v4/connections`](https://docs.equinix.com/api-catalog/fabricv4/connections/createconnection.md) endpoint. The connection `type` is `IP_VC`. Define your Fabric Cloud Router in the `aSide` object including: * Set `accessPoint.type` as `CLOUD_ROUTER`. * Set `router.uuid` as your router's UUID. Provide your GCP details and location details in the `zSide` object including: * Set `accessPoint.type` as `SP`. * Set `profile.type` as `L2_PROFILE`. * Specify the service profile you are connecting to in `profile.uuid`. * Specify the Equinix Metro location you are connecting to in `location.metroCode`. * Set `authenticationKey` as your Google Cloud-issued pairing key. Ensure that: * If you are creating a connection where the `redundancy` is `PRIMARY` that the pairing key ends in `/1` and you are using the Google Cloud Partner Interconnect Zone 1 service profile UUID `bd4570e2-d792-4a00-87f5-3bde040cdcd7`. * If you are creating a connection where the `redundancy` is `SECONDARY` that the pairing key ends in `/2` and you are using the Google Cloud Partner Interconnect Zone 2 service profile UUID `b97dacca-abe6-4e8c-8be1-fcdd1be1defe`. * If you are creating redundant connections, send two API requests, one for each redundancy priority. Specify any other connection configuration details, in the body of the request. For a full list of parameters and their descriptions, see the [API Reference](https://docs.equinix.com/api-catalog/fabricv4/connections/createconnection.md). Sample cURL Request: ``` POST 'https://api.equinix.com/fabric/v4/connections' -H 'content-type: application/json' -H 'authorization: Bearer ' -d '{ "type": "IP_VC", "name": "", "bandwidth": "redundancy": { "priority: "" }, "aSide": { "accessPoint": { "type": "CLOUD_ROUTER", "router": { "uuid": "" } } }, "zSide": { "accessPoint": { "type": "SP", "profile": { "uuid": "" }, "location": { "metroCode": "" }, "authenticationKey": "", "sellerRegion": "" } }, "order": { "purchaseOrderNumber": "" }, "notifications": [ { "type": "ALL", "emails": [ "", "" ] } ] }' ``` ## Connecting using a Service Token[​](#connecting-using-a-service-token "Direct link to Connecting using a Service Token") To create a connection using an A-side Service Token to AWS, send a `POST` request to the [`/fabric/v4/connections`](https://docs.equinix.com/api-catalog/fabricv4/connections/createconnection.md) endpoint. The connection `type` is `EVPL_VC`. Provider your Service Token UUID to in the `aSide` object. The service token provides all other necessary information to establish the connection. Provide your GCP details and location details in the `zSide` object including: * Set `accessPoint.type` as `SP`. * Set `profile.type` as `L2_PROFILE`. * Specify the service profile you are connecting to in `profile.uuid`. * Specify the Equinix Metro location you are connecting to in `location.metroCode`. * Set `authenticationKey` as your Google Cloud-issued pairing key. Ensure that: * If you are creating a connection where the `redundancy` is `PRIMARY` that the pairing key ends in `/1` and you are using the Google Cloud Partner Interconnect Zone 1 service profile UUID `bd4570e2-d792-4a00-87f5-3bde040cdcd7`. * If you are creating a connection where the `redundancy` is `SECONDARY` that the pairing key ends in `/2` and you are using the Google Cloud Partner Interconnect Zone 2 service profile UUID `b97dacca-abe6-4e8c-8be1-fcdd1be1defe`. * If you are creating redundant connections, send two API requests, one for each redundancy priority. Specify any other connection configuration details, in the body of the request. For a full list of parameters and their descriptions, see the [API Reference](https://docs.equinix.com/api-catalog/fabricv4/connections/createconnection.md). Sample cURL Request: ``` POST 'https://api.equinix.com/fabric/v4/connections' -H 'content-type: application/json' -H 'authorization: Bearer ' -d '{ "type": "EVPL_VC", "name": "", "bandwidth": "redundancy": { "priority: "" }, "aSide": { "serviceToken": { "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4" } }, "zSide": { "accessPoint": { "type": "SP", "profile": { "uuid": "" }, "location": { "metroCode": "" }, "authenticationKey": "", "sellerRegion": "" } }, "order": { "purchaseOrderNumber": "" }, "notifications": [ { "type": "ALL", "emails": [ "", "" ] } ] }' ``` ## Monitoring the Connection Status[​](#monitoring-the-connection-status "Direct link to Monitoring the 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` parameter values | `providerStatus` attribute values | **Google Status** | **Description** | | -------------------------------- | --------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------- | | `PROVISIONING` | `PROVISIONING` | | Connection request has not been sent to Googleyet. | | `PROVISIONED` | `PENDING_APPROVAL` | Waiting for service provider. | Connection waiting for acceptance. | | `PROVISIONED` | `PROVISIONING` | Activation needed -> Border Gateway Protocol (BGP) configuration required. | Connection establishment in progress. | | `PROVISIONED` | `PROVISIONED` | Pending -> availability | Connection accepted by client. | ## Activating the Connection[​](#activating-the-connection "Direct link to Activating the Connection") Activate the virtual connection using Google Cloud Platform. Refer to the [Google Cloud documentation](https://console.cloud.google.com/) for instructions on how to activate the connection using Google Cloud Platform Console.