How to Guide
Connect to AWS
Connect to Microsoft
Connect to Google
Connect to Oracle
Connect to Oracle Government Cloud
Connect to IBM
Connect to Alibaba
Connect to Enterprises
Connect to Myself
Create Service Profile
Approve or Reject Connection
Authorize Buyer to access private service profile
Update Bandwidth/Speed of a connection
V3 APIs Migration
- API Reference
What is Equinix Cloud Exchange Fabric?
Equinix Cloud Exchange Fabric (ECXF) is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port.
Customers can use ECXF to connect to:
- Cloud Service Providers - Clouds, network and other service providers.
- Enterprises - Other Equinix customers, vendors and partners
- Myself - Another customer instance deployed at Equinix.
ECXF is offered to customers through Equinix Cloud Exchange Fabric web portal and REST APIs.
What are Equinix Cloud Exchange Fabric APIs?
The Equinix Cloud Exchange Fabric APIs are a collection of REST APIs that allow you to programmatically order, create, delete and monitor private virtual connections on the ECX Fabric. (Refer API reference section or Catalog for more details.)
How do the Equinix Cloud Exchange Fabric APIs work?
When a customer is on-boarded, they are provided with user credentials.
The customer must use these credentials to connect to the Equinix Developer Platform to generate a Consumer key and Consumer secret, also known as client ID and client secret.
The Consumer key and Consumer secret are essential for obtaining access and refresh tokens to authenticate API calls as described in the subsequent section.
Refer to Generating a Client ID and Client Secret key under the Getting Started section for instructions on how to generate Consumer key and Consumer secret.
ECXF Cloud Service Provider Workflow
Step 1 - Retrieve connection credentials from the cloud service provider. For example, Account ID for AWS, Service key for Azure etc.
AWS console https://aws.amazon.com/console/
Azure portal https://azure.microsoft.com
Google console https://console.cloud.google.com/
Oracle console https://www.oracle.com/cloud/
Step 2 - Request access and refresh token information by calling the Equinix OAuth API (/oauth2/v1/token) with the Consumer key, Consumer secret, and user credentials.
Refer to Requesting Access and Refresh tokens under the Getting Started for instructions on how to obtain an Authorization Token.
Step 3 - The API gateway makes an OAuth2 call to the identity provider using the submitted credentials.
Step 4 - The identity provider returns an OAuth2 Access token to the API gateway.
Step 5 - The API gateway sends back the authorization token details to the customer.
API Request flow:
Step 6 - The customer submits an API request with the obtained authorization token and respective API request payload.
Refer to the How to Guide section for instructions on how to call Equinix Cloud Exchange Fabric APIs to establish connections.
Step 7 - API gateway validates the request and calls the relevant API.
Step 8 - The response is received by the API gateway.
Step 9 - The response is sent back to the customer.
Step 10 - Customer acknowledges connection using the console provided by the respective cloud service provider (a) or via Equinix Cloud Exchange Fabric portal (b) or APIs (c).
Equinix Cloud Exchange Fabric portal https://docs.equinix.com/en-us/Content/Interconnection/ECXF/landing-pages/ECXF-landing-main.htm
Refer to the How to Guide section for instructions on how to accept connections using Equinix Cloud Exchange Fabric APIs.