ECX Fabric API Documentation

 

API Overview

Equinix Cloud Exchange Fabric (ECX Fabric) enables enterprises and service providers to do more in the cloud by providing secure, direct, flexible network connections to a wide range of cloud service providers globally. Our interconnected approach allows you to boost cloud application performance, reduce latency, and improve scale, network control, and visibility to deliver a quality cloud experience to your end users.

 

ECX Fabric APIs facilitate automated interconnection across the ECX Fabric at both OSI Layer 2 and Layer 3. The APIs provide the capabilities necessary to create connections to essentially any other ECX participant including major cloud providers such as Amazon Web Service (AWS), Microsoft Azure, Google Cloud Platform (GCP), Oracle Cloud and many others.

 

ECX Fabric participants who would like to make their services available to others on the platform can do so by creating a new “service profile”. We offer APIs that facilitate the creation and manipulation of ECX service profiles, which allow participants on the platform to define their offered services and/or applications and how they would like others to connect to that service.

 

All of our ECX Fabric APIs are organized around REST – therefore any developer familiar with a RESTful API should be able to quickly get started. We use standard HTTP features, like HTTP verbs, which can be understood by many HTTP clients. JSON will be returned in all responses from the API, including errors. The APIs are designed to have predictable, straightforward URLs and to use HTTP response codes to indicate API errors.

 

The ECX APIs are built to allow participants to create a connection to another provider quickly and easily. The ecosystem of developers establishing connections on top of the APIs is strong and diverse, ranging from network providers to large enterprise organizations.

Here are a couple key areas of functionality included in the ECX Fabric APIs:

 

Key Components

Layer 2 Connections

 

APIs are available to both create and delete Layer 2 virtual circuit connections between two UNI ports on the ECX Fabric. The primary use case is creation of a private connection to AWS, Azure, Google or other cloud provider destinations. Yet these APIs can also be used to create a connection to any other participant on the ECX Fabric, including those that do not reside in the same local metro. Additionally, ECX participants may wish to connect between your own assets deployed with Equinix around the world. (See diagram below)

 

 

All virtual circuit connections are between two ports on the ECX Fabric and can be between Network Service Providers (NSPs), Cloud Service Providers (CSPs), or other ECX participants on the fabric platform. The ECX port API returns port details that can be used in subsequent API calls.

 

 

Remote Connections

A virtual connection is between two ports on the ECX platform, however, those ports may or may not be in the same metro. An ECX participant may create connections from their port in one metro to a service provider in another metro or to their own port in another metro. These inter-metro connections are commonly referred to as remote connections. Today, remote connections are allowed within the same region (AMER, EMEA or APAC). However, in the near future ECX participants will be able to create remote connections across different regions.

There is no specific API for a remote connection, the same Connections APIs (described in more detail below) would apply. However, please remember to include the metro code for the remote location in the API parameters when calling this Post Connections API. And also note there is an additional charge for a remote connection.

 

Layer 3 Connections

At the Layer 3 level, four different ECX components can be combined in multiple ways to connect routed services. Details about Layer 3 components can be found here but the basic object structure looks like the below.

 

 

 

Service Profiles

Service profiles define how an ECX participant would like other ECX participants (Service Providers, Customers, Partners, etc.) to connect to their services on the Fabric. Some attributes of service profiles include but are not limited to:

 

  • Require the participant to provide an authorization key to connect
  • Private vs. Public – who can see this service profile as a destination to connect
  • Offered bandwidth tiers
  • Notification emails
  • Redundancy - indicate if you require redundant connections to your service

 

Actions on service profiles that can be performed with the APIs include:

 

  • Return a list of all service profiles for a given metro
  • Return a list of all service profiles 
  • Return a list of all service profiles for a given uuid/customer
  • Create a Service Profile
  • Update an existing Service Profile
  • Return a list of all seller regions based on the integration id
  • Delete a Service Profile based on Profile Name or UUID

 

Availability

The ECX Fabric APIs can be accessed via our developer portal at https://developer.equinix.com

Service Providers available for interconnection at both Layer 2 and Layer 3 can be found here.

Want to know more about ECX Fabric? Click here

 

Questions/Feedback/Support

Equinix is committed to helping you achieve your automation goals using our wide range of APIs.  If you have any questions feel free to reach out to api-support@equinix.com

Twitter Feed

About Equinix

Equinix connects the world's leading businesses to their customers, employees and partners inside the world's most connected data centers in 44 markets across five continents. In the United States, Equinix operates data centers in Atlanta, Boston, Chicago, Dallas, Denver, Los Angeles, Miami, New York, Philadelphia, Seattle, Silicon Valley and Washington D.C.

Developer Platform - Key Highlights

  • Explore, Subscribe & Connect to Equinix API Ecosystem‚Äč
  • Test Drive Equinix APIs using our Playground
  • Start your journey with Getting Started Guide

Recent News

  • Developer Forum is now Live
  • You can download the API catalog now in PDF or JSON or HTML or YAML
  • New Developer Experience Launched! Let us know your feedback.
  • ECX Fabric v3 API is recommended for integration.
  • Equinix Customer Portal APIs (Beta) is now available on Playground.
  • IBX SmartView Streaming API is now available on Developer Platform