Frequently Asked Questions

Getting Started

  • What APIs does Equinix provide?
  • Our customers use Equinix APIs to automate internal business workflows around ordering & ticketing, user administration, asset monitoring and to stream real-time power information. You can find the entire catalog of Equinix APIs at https://developer.equinix.com/catalog

  • Why am I getting an agreement to accept?
  • To provide the clarity to the users of our developer platform and APIs with the contractual details, we are requesting all our platform users to read and accept the agreement before they can leverage the services offered. This is also done as part of the legal compliance.

  • Does Equinix follows any API documentation standard?
  • Yes. All Equinix API catalogs are Swagger 2.0 compliant.

  • Does Equinix charge for the APIs?
  • No. Currently the APIs are free of charge for everyone.

  • Are there any data limits for a single application or a developer?
  • No. Currently there are no limits, however, we track traffic associated with an individual API Key.

  • Where can I find Equinix API Catalog & SDKs?
  • Equinix API Catalogs is available to view and download (.pdf) via the Equinix Developer platform.  We are going to provide more catalog download formats like JSON/YAML in the upcoming releases. 

  • Do I need to register to use APIs?
  • Yes. To use the APIs in Production environment with real data, you need to be an Equinix Customer. Please contact Equinix API Support at api-support@equinix.com to understand more.

    However incase you are here to just try out our APIs, you can quickly register to the Playground to get your 30 day free access token 

Access & Security

  • Why is OAuth 2.0 not working?
  • As part of our ongoing commitment to security, we have released a patch update on the 10th of June 2019 to support client_credentials grant type for OAuth2. (Equinix authentication API).
    If you are facing any issues with your existing authentication API request, ensure that you are passing the correct headers and values for the appropriate grant type.
    Click here for more information

  • How to gain access to Equinix Sandbox?
  • If you are a new API customer, send an email to api-support@equinix.com to get access to Equinix sandbox. For existing API customers, log in to developer platform and create a sandbox app to obtain your sandbox specific consumer key and consumer secret to access sandbox APIs. You can find the entire catalog of Equinix APIs at https://developer.equinix.com/catalog

  • What kind of Security features is available for Equinix APIs?
  • Equinix provides OAuth2.0 APIs which leverages credential masking features. If you have any specific questions on the detail security aspects of an API or would like other features enabled on our platform, please send an email to api-support@equinix.com

  • Why do I see an Authorization Token in Playground Catalogs?
  • The Authorization Token is a required field to test drive APIs only on Playground. Authorization key helps Equinix to authorize developer requests on Playground to keep it secure. 

    Note that for accessing Equinix APIs in Production, Auth Token is required as a header attribute that can be retrieved via Equinix OAuth 2.0 Auth Token API. 

  • Does Equinix Authentication incorporate TLS or SSL?
  • Equinix Authentication incorporates TLS. Currently only TLS 1.0, 1.1 and 1.2 versions are supported and enforced.

Development

  • It says Equinix Fabric™ v3 APIs are recommended. Why?
  • Yes. If you want to leverage the best of Equinix Fabric™ API capabilities, we recommend to use version 3. If you have any questions around the rich feature set, we would be happy to demo you the APIs. Please note that we are also recommending our customers to migrate from older versions (v1, v2) to v3 as we will stop Equinix Fabric™ v1 & v2 APIs support by 5 January 2020. 

  • What does Beta APIs means?
  • Beta APIs simply means that we are providing a sneak peak of our upcoming APIs for your reference to understand and test drive our APIs. We DO NOT recommend to use the APIs in Production and does not provide any operational support or SLA around our Beta APIs. 

    For example, Equinix Customer Portal APIs are currently in Beta Stage. Even though we are trying our best to provide the highly reliable and scalable APIs, Beta APIs can change in contract and are not recommended to use in production. You can use the Beta APIs in test environment and test your workflows.

    If you have any questions on the capabilities of our Beta APIs, we are happy to help. Please send us a request using Contact Us form or send an email to api-support@equinix.com

  • How do I test my workflows with Equinix APIs?
  • Equinix provides API Playground to test drive Equinix APIs. Equinix API Playground helps developers to understand the API definitions and test the business workflows using Mock response objects. To register for playground, please go to https://developer.equinix.com/playground/access

  • Is there a WADL or some other URL that describes the services dynamically?
  • Equinix follows Swagger 2.0 documentation standard. Currently we do not have any plans to provide WADL services. If your business needs WADL specification, please contact api-support@equinix.com

  • What kind of Caching Features is supported for Equinix APIs?
  • Equinix provides “Response based” caching for most of the APIs. Equinix also provides user token level granular caching mechanisms on-need basis based on the API Key & Secret.
    Currently Equinix does not support ETAG feature to validate the old/new caching entity. If your business needs ETAG headers, please contact api-support@equinix.com 

  • Have any API endpoints been deprecated or removed from Production environment?
  • As part of our ongoing commitments to customers and partners around platform integration, we have launched a new initiative to simplify Equinix API specifications. We will be removing a few APIs from the available catalogs that are currently not being used in production.

    You may review this list of APIs and let us know via Forum if you have any questions or concerns. These APIs shall be removed by 29 June 2020 (COB) pacific time.

  • What are the available developer environments?
  • The playground environment is targeted at prospects who are keen on exploring Equinix API offerings. The sandbox environment is used by customer developers for integrating with Equinix APIs before moving to production (LIVE) environment. Refer to Playground, Sandbox and Production for more information.

About Equinix


We connect 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.