‌Frequently Asked Questions

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

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.

Yes. All Equinix API catalogs are Swagger 2.0 compliant.

No. Currently there are no limits, however, we track traffic associated with an individual API Key.

Yes, you need to be an existing Equinix Customer to use our APIs. If you have any issues getting started with APIs, you can reach us by creating a support case.

In general, we provide deprecation notice 12 months in advance unless otherwise specified. There are 2 key dates to take note:

End of Support (6months from deprecation notice): API will stop receiving patches and bug fixes to deprecated version. Support for API will be limited

End of Life (12 months from deprecation notice): API will no longer be available and users are strongly recommended to migrate and/or handle this change before this date to avoid breaking integration.

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

Log in to Customer Portal and create a sandbox app within Developer Settings to obtain your sandbox consumer key and consumer secret to access sandbox APIs. For more information on getting access token, please see this guide.

Equinix provides OAuth2.0 APIs which leverages credential masking features. 

Equinix Authentication incorporates TLS. Currently only TLS 1.2 and 1.3 versions are supported and enforced.

Yes. If you want to leverage the best of Equinix Fabric™ API capabilities, we recommend to use version 4. 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 version v3 to v4 as we will stop Equinix Fabric™ v3 APIs support by December 2023. 

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 by raising a Support Case or send an email to support@equinix.com

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.

The sandbox environment is used by customer developers for integrating with Equinix APIs before moving to production (LIVE) environment. Refer to Sandbox and Production for more information.