Skip to main content

Effective 10 September 2024, API Documentation can be found on our Equinix Product Documentation site.
The content on this page will not be updated after 1 Oct 2024 and will be inaccessible after 31st Dec 2024.


2022

Equinix Customer Portal - December 2022 R2022.6 Release Notes

Release Overview
Release date: December 12, 2022
With this release, we provide an update to Billing_v2.
To view and download these updated and new Equinix Customer Portal APIs, refer to the API Catalog.
To view the related Documentation, refer to the respective methods in the Summary below.

FeatureSummary of Release
Billing_v2
(update)

For GET Invoices Details:

Modified the limit (up to 100 accounts) of a single call for accountNumbers query parameter.

Equinix Customer Portal - November 2022 R2022.5.1 Release Notes [patch]

Release Overview
Release date: November 03, 2022
With this release, we provide an update to Billing_v2.
To view and download these updated and new Equinix Customer Portal APIs, refer to the API Catalog.
To view the related Documentation, refer to the respective methods in the Summary below.

FeatureSummary of Release
General guidance
on order source
(update)

Type of order source

Updated guidance on order source types (channel and subChannel) for billing details. Reflected order source for NRC Charge Upload value - see Billing: Order Source under the Appendix section.

Equinix Customer Portal - October 2022 R2022.5 Release Notes

Release Overview
Release date: October 13, 2022
With this release, we provide updates to Billing_v2 and Users_v2. Additionally, we announce the billing address change for all billing, account balance-related inquiries, and document requests.
To view and download these updated and new Equinix Customer Portal APIs, refer to the API Catalog.
To view the related Documentation, refer to the respective methods in the Summary below.

FeatureSummary of Release
Billing_v2
(update)

For GET Invoices:

Enabled support for Brazil invoices or credit memo summary.

NOTE: The CNPJ (Cadastro Nacional da Pessoa Jurídica) registration number for Brazil accounts will be available in the future release for API users.
Users_v2
(update)
For GET Users:
  •  Added the following response fields: title and department to enable audit details.
General guidance on billing email address (update)

Billing email address change:

As of 8 August, Equinix’s credit control and billing support emails have changed for all regions. All billing, account balance-related inquiries, and document requests should be sent to askbilling@equinix.com.

Note that billing email addresses on invoices and credit memos generated before September 2022 reflect the legacy billing email addresses.

In addition, your Account Payables system should also send the remittance advice to remittance@equinix.com; with your Equinix Customer Account Number in the email subject.

Equinix Customer Portal - September 2022 R2022.4.1 Release Notes [patch]

Release Overview
Release date: September 15, 2022
This release introduces enhancements to Billing_v2. We also added a new resource Billing: Order Source in the Appendix to display order source for billing details API.
To view and download these updated and new Equinix Customer Portal APIs, refer to the API Catalog.
To view the related Documentation, refer to the respective methods in the Summary below.

FeatureSummary of Release
Billing_v2
(new)

For GET Invoices Details:

Added new channel and subChannel fields to display order source in billing details API so that you can differentiate your orders.
General guidance
on order source
(update)

Type of order source

Provided guidance on order source types (channel and subChannel) for billing details - see Billing: Order Source under the Appendix section.

Equinix Customer Portal - August 2022 R2022.4 Release Notes

Release Overview
Release date: August 11, 2022
With this release, we provide enhancements to Assets_v1. It also updates CrossConnects_v2 and Lookup_v2. Additionally, we deprecated prewired flag for Lookup_v2.
To view and download these updated and new Equinix Customer Portal APIs, refer to the API Catalog.
To view the related Documentation, refer to the respective methods in the Summary below.

FeatureSummary of Release
Assets_v1
(new)

For POST /assets/search (Retrieve Asset Data):

Added CROSS_CONNECT_Z_SIDE enum for productTypes body parameter:
  • Enabled customers to view A-side details based on their Z-side
  • You can now search for connected A-side peers using Assets API
CrossConnects_v2
(update)

Order Validation for ICCC

Equinix now converts standard Cross Connect orders to Intra Customer Cross Connect (ICCC) orders when the order configuration is determined to be of ICCC, and ICCC pricing will be applied.

If you have any questions, contact Equinix API support at api-support@equinix.com.
Lookup_v2
(update)

For GET Locations:

Added a new connectionService query parameter.
  • The IBXs are returned based on the supported connection service.
Users will now be required to include connectionService when searching for zSide patch panel details when permissionCode is CROSS_CONNECT. This validation will be in effect on July 1, 2023 to maintain backward compatibility for the current users.
Lookup_v2
(update - field deprecation)

For GET PatchPanels:

  • We recently discovered that GET PatchPanels API returns the preWired flag
  • This behavior is unexpected, and we will remove this field by July 1, 2023 to maintain backward compatibility for the current users.

Equinix Customer Portal - July 2022 R2022.3.1 Release Notes [patch]

Release Overview
Release date: July 14, 2022
With this release, we provide update to Billing_v2
To view and download these updated and new Equinix Customer Portal APIs, refer to the API Catalog.
To view the related Documentation, refer to the respective methods in the Summary below.

FeatureSummary of Release
Billing_v2
(update)
Updated the table Billing Invoice: API vs. Excel which shows the relationship between the billing API fields and the corresponding names on the Excel billing invoice.

Equinix Customer Portal - June 2022 R2022.3 Release Notes

Release Overview
To ensure better accessibility, we moved releae notes from the Announcements to the Equinix Customer Portal under the Release Notes section .
Release date: June 16, 2022
With this release, we provide update to Users_v2.
To view and download these updated and new Equinix Customer Portal APIs, refer to the API Catalog.
To view the related Documentation, refer to the respective methods in the Summary below.

FeatureSummary of Release
Users_v2
(update)
Enabled audit details for:
  • GET Users - added the following response fields: createdDateTime and updatedDateTime

Equinix Customer Portal - April 2022 R2022.2 Release Notes

Release Overview
Release date: April 11, 2022
This release brings the deprecation notice for WorkVisit_v1.
To view and download these updated and new Equinix Customer Portal APIs, refer to the API Catalog.
To view the related Documentation, refer to the respective methods in the Summary below.

FeatureSummary of Release
WorkVisit_v1
(deprecation)

Equinix will be deprecating Work Visit v1 API by May 1, 2023.
Therefore, we strongly recommend users migrate to Work Visit v2 API and Lookup v2 (location search) API before this date.
We will end support for workvisit_v1 API on Dec 1, 2022.
For information on the API v2, see the Workvisit v2 and Lookup v2 documentation.

If you have any questions, contact Equinix API support at api-support@equinix.com

Equinix Customer Portal - March 2022 Release Notes

Release Overview
Release date: March 31, 2022
This release introduces enhancements to CrossConnects_v2. It also updates Orders_v2 and Quotes_v2.
Additionally, we have added a new resource in Appendix (ECP Permissions vs. APIs) to display the relationship between user permissions and APIs.
We have also added a tutorial (Using Access Tokens) on using bearer token to make sample API call.
To view and download these updated and new Equinix Customer Portal APIs, refer to the API Catalog.
To view the related Documentation, refer to the respective methods in the Summary below.

FeatureSummary of Release
CrossConnects_v2
(new)

For POST CrossConnects Deinstall

  • Added a new endpoint to deinstall cross connect asset(s) for the Equinix customer (A-side).
General guidance on permissions (update)

ECP Permissions:

 
  • ECP Permissions vs APIs
    Provided guidance on what ECP permissions you need to access the corresponding APIs - see ECP Permissions vs. APIs under the Appendix section.

  • Fabric permissions
    Customers who are copying Fabric-related permissions will need to do this via the Fabric portal as the API currently does not support Fabric permissions copy.
General guidance on acces token (update)

ECP Access Token:

Explained how the Equinix APIs use OAuth 2.0 protocol to authenticate the requests you make to the API endpoints. 

This includes Equinix's access token called Bearer token used to access and exchange data with the Equinix APIs. Also, provided examples how to make a simple API call using the Bearer scheme.

See Using Access Tokens under the Getting Started >> Getting Access Token section for more information.

Equinix Customer Portal - February 2022 R2022.1 Release Notes

Release Overview
Release date: February 24, 2022
This release introduces enhancements to Billing_v2 and Resellers_v2. It also updates CrossConnects_v2. Additionally, we deprecated insure shipment parameter for Shipments_v2.
To view and download these updated and new Equinix Customer Portal APIs, refer to the API Catalog.
To view the related Documentation, refer to the respective methods in the Summary below.

FeatureSummary of Release
Billing_v2
GA
(new)

For GET Invoices Details

Added new attributes to support new columns in detailed invoice. You can see information on:

  • productName
  • additionInfo: {key, value}
    • key:
      • SPACE_ID
      • FIRST_PRICE_INCREASE
      • PRICE_INCREASE_PERCENTAGE
    • termsOfUse: {value, type, period}
      • value: e.g., 12, 24, 36
      • type: INITIAL_TERM, RENEWAL_TERM
      • period: MONTHS

Additionally, we also:
Extended the Billing Invoice: API vs. Excel table which shows the relationship between the billing API fields and the corresponding names on the Excel billing invoice to reflect the above changes.
CrossConnects_v2
(update)

For POST Order Cross Connects, we made the following updates:

  • Now, zSide notificationEmail is mandatory field for fast provisioning (FP) patch panels during CC orders.
  • Also, for fast provisioning patch panel, aSide connectorType must be LC.
Resellers_v2
(new)

For POST /resellers/{accountNumber}/customers

Added a new customerType mandatory body parameter to create one of the following customer type:

  • END_CUSTOMER (customer of the Reseller)
  • SUB_DIVISION (a sub dept/organization where the Reseller is the parent/holding company)

NOTE: We now require users to specify their customerType (i.e., end customer or sub division) during customer creation. For customers that created users before 16 Feb 2022, you will be requested to include customerType when you modify your customer details.
Shipments_v2
(update - field deprecation)

For Schedule Outbound Shipment and PATCH Shipments {orderId}, we made the following updates:

We no longer insure outbound shipment. This field will be deprecated.