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.


2021

Equinix Customer Portal - November 2021 R2021.11 Release Notes​

Release Overview
Release date: November 25, 2021
This release introduces enhancements to Orders_v2, and it also updates Shipments_v2. We improve the managing of orders for cross connect and smart hands.
Finally, we are going to deprecate the CrossConnects_v1 and Users_v1 APIs.
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
(update)		For POST Order Cross Connects, we made the following updates:
  • Modified the limit (1-48) of the ifcCircuitCount body parameter.
CrossConnects_v1
(deprecation)		Equinix will be deprecating CrossConnect_v1 API by 1st December 2022. Therefore, we strongly recommend users migrate to CrossConnect_v2 API before this date.
Orders_v2
Beta
(new)		For GET Orders {orderId}:
  • Enabled cross connect - installation fee and network cable connection details for cross connect orders – see Orders: Managing Additional Info in the Appendix section.
    • For each object line, you can see additional information about the status of the cross connect.
  • Enabled smart hands flag for orders – see Orders: Managing Additional Info in the Appendix section.
    • For each object line, you can see additional information about the status of the smart hands charges – this helps avoid double charging customers.
Shipments_v2
(update)		For PATCH Shipments {orderId}, we made the following updates:
  • Updated information on Outbound Shipments
    • When updating carrier or carrierName body parameters you need to provide shipping label details using either shipmentAddress or shipmentAttachmentId parameters.
    • The shipmentLabelRequired is true by default.
Users_v1
Beta
(deprecation)		Equinix will be deprecating Users_v1 API by 1st December 2022. Therefore, we strongly recommend users migrate to Users_v2 API before this date.

Equinix Customer Portal - October 2021 R2021.10 Release Notes​

Release Overview
Release date: October 28, 2021
This release introduces enhancements to Orders_v2 and Quotes_v2. We introduce quote types used for product ordering as well as improve the managing of work visit orders.
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
Orders_v2
Beta
(new)		For GET Orders {orderId}:
  • Added quoteRequestType response field. You can find information on the supported Quote Types in the Appendix section.
  • Enabled visit type details for work visit orders – see Orders: Managing Additional Info in the Appendix section.
    • For each object line, you can see additional information about the status of the work visit.
    • The VISIT_TYPE is one of the following types:
      • ATTENDED
      • NOT_ATTENDED
      • NO_LONGER_VISITING
      • ATTENDED_AND_NO_LONGER_VISITING
    • The visitor details refer to both registered and non-registered users.
  • Enabled visit start and end datetime for work visit orders – see Orders: Managing Additional Info in the Appendix section.
    • For each object line, the work visit orders provide additional information on scheduled work visits as follows:
      • VISIT_START_DATETIME
      • VISIT_END_DATETIME
Quotes_v2
(new)		For GET Quotes {quoteId}:
  • Added quoteRequestType response field. You can find information on the supported Quote Types in the Appendix section.

Equinix Customer Portal - September 2021 R2021.09 Release Notes​

Release Overview
Release date: September 30, 2021
This release introduces enhancements to CrossConnects_v2, Lookup_v2, Quotes_v2, and Users_v2. It also updates Orders_v2, Shipments_v2, and WorkVisit_v2.
We also introduce a new endpoint and method to copy permissions from an existing user to another user.
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 Order Cross Connects
  • Provided guidance on how to manage different types of values for patch panel port A and port B.
CrossConnects_v2
(update)		For POST Order Cross Connects, we made the following updates:
  • Enhanced diverseConnections, we no longer show connectionService, mediaType, and protocolType on the aSide.
  • Aligned date to have 'YYYY-MM-DD' format for startDate and endDate of the purchase order.
  • Introduced schemas for zSide: zSideWithLOA and zSideWithPatchPanel. They refer to LOA customer and customer with patch panel respectively.
  • The accountNumber for zSide is no longer required.
  • Improved error messaging when an incorrect IBX mandatory field is provided for zSide.
Lookup_v2
(new)		For GET PatchPanels {patchPanelId}
  • Added usedPortsDetails.circuitId field to patch panel on the zSide to enhance verification process. This is the same zSide circuit ID as used for cross connects order.
Orders_v2
Beta
(update)		For GET Orders {orderId}, we made the following updates:
  • Fixed the billingStartDateTime - it was showing as commencementDateTime.
Quotes_v2
(new)		For GET Quotes {quoteId}
  • Added details.lineItemModified flag to display provisioned SKUs for MACD quotes.
Shipments_v2
(update)		For POST Schedule Inbound Shipment and POST Schedule Outbound Shipment, we made the following updates:
  • Aligned date to have 'YYYY-MM-DD' format for startDate and endDate of the purchase order.
Users_v2
(new)		For POST Copy User Permissions
  • Added a new endpoint to copy permissions from an existing user to another user. Only Master Admin and IBX Admin user roles can perform the copy permissions.
WorkVisit_v2
(update)		For POST Schedule Work Visit, we made the following updates:
  • Aligned date to have 'YYYY-MM-DD' format for startDate and endDate of the purchase order.

Equinix Customer Portal - August 2021 R2021.08 Release Notes​

Release Overview
Release date: August 16, 2021
This release introduces enhancements to Billing_v2, CrossConnects_v2, Orders_v2 and Quotes_v2.
It also updates Shipments_v2, Tickets_v2, and WorkVisit_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
(new)		For GET Invoices:
  • Provided additional credit memo details that shows the applicable invoice number, date, and value.
For GET Invoices Details:
  • Added DEINSTALL enum (as line item) for activityType response field.
Billing_v2 (update)For GET Invoices, we made the following updates:
  • Enhanced invoices for EMEA and APAC regions, we no longer show first name and last name as billing contacts and show Billing Team instead.
  • Improved customerDetails.address.countryCode, we now show country code as GB (not UK). Refer to appendix for full list of supported country codes.
For GET Invoices Details, we made the following updates:
  • Modified customerDetails.countryCode, we now show country code as GB (not UK). Refer to appendix for full list of supported country codes.
CrossConnects_v2
(new)		For POST Order Cross Connects
Enhanced selection value for optional LC and SC connector type. User can pass value of -1 when port B is not required for aSide and zSide.
CrossConnects_v2
(update)		For POST Order Cross Connects, we made the following updates:
  • The 'type' of contacts applies to registered and non-registered users.
  • Only one technical contact can be passed.
  • Introduced different schemas for zSide details along with improved error messaging when existing or new customer mandatory fields for Z side are missing
  • Multi-quantity orders now support up to 10 cross connects.
  • Modified error message to display Patch panel identifier instead of index [id] when it does not have enough ports available for all connections.
  • The 'circuitId' is now optional for zSide.
  • The 'accountNumber' for aSide is no longer required.
  • The 'connectionService' for zSide is no longer required.
Orders_v2
Beta
(new)		For GET Orders {orderId}
  • Added details.attachments to show attachment details at line items level.
  • Enabled 1-way & 2-way notes in communication logs. The notes field is returned if associated with an order.
  • Added information on registered and non-registered visitors for the WORK_VISIT enum of the productType field.
  • The productName displays as 'Contact' for the registered user and 'Visitor' for non-registered visitor
Quotes_v2
(update)		For GET Quotes {quoteId} we made the following updates:
  • details.quantity format is of number type.
  • details.rootLineId is displayed.
Shipments_v2
(update)		For POST Schedule Inbound Shipment and POST Schedule Outbound Shipment, we made the following updates:
  • The 'type' of contacts applies to registered and non-registered users.
  • Only one technical contact can be passed.
Tickets_v2
Beta
(update)		For POST Submit Trouble Ticket, we made the following updates:
  • The 'type' of contacts applies to registered and non-registered users.
  • Only one technical contact can be passed.
WorkVisit_v2
(update)		For POST Schedule Work Visit ,we made the following updates:
  • The 'type' of contacts applies to registered and non-registered users.
  • Only one technical contact can be passed.

Equinix Customer Portal - July 2021 R2021.7 Release Notes​

Release Overview
Release date: July 29, 2021
This release introduces enhancements to CrossConnects_v2 and Lookup_v2. It also retires the Code Samples section.
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
(update)		For POST Order Cross Connects
  • Introduced an error message when Patch panel [id] does not have enough ports available for all connections.
  • Enabled two types of payloads for zSide and its mandatory fields to support LOA attachment.
  • Use description field to add additional information for Cross Connects order.
Lookup_v2
(update)

For GET PatchPanels {patchPanelId}, the format of cabinetId response filed is updated. We now display it using the following pattern AE1:01:010010:0003.

The Cross Connects enum value for the permissionCode query parameter is updated. We now display CROSS_CONNECT for GET Locations.
Code Samples
(retired)		Removed the Code Samples section. It is marked as retired.

Equinix Customer Portal - June 2021 R2021.06 Release Notes​

Release Overview
Release date: June 25, 2021
This release introduces Notifications_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
Notifications_v1

Notifications API allows you to manage your IBX and Network notifications.

With these endpoints, you can now achieve the following:

Equinix Customer Portal - May 2021 R2021.05 Release Notes​

Release Overview
Release date: May 28, 2021
With this release, we introduce enhancements to SupportPlans_v2 Beta, Users_v2 GA, Tickets_v2 Beta, and Billing_v2 GA.
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
SupportPlans_v2
Beta
(update)		Added a new query parameter planIds for GET SupportPlans.
You can now filter Smart Hands Support Plans (SHSP) using your plan IDs.
Users_v2
GA
(update)

Enabled audit details for:

  • GET Users {username} - added the following response fields: activationDateTime, createdDateTime, updatedDateTime, and updatedByFullName
  • GET Users - added the following response fields: activationDateTime, deactivationDateTime, and deletedDateTime

Added a new ENUM value (NOT_APPLICABLE) to the securityProfile response field for GET Users

Introduced an error message (400 Bad Request) for PATCH users {username} - once a user is granted IBX access permission, their first and last names can only be updated by a Master Administrator.
Tickets_v2
Beta
(update)

Introduced new Metro Connect ticket type:

  • Added trouble ticket codes ("0012-0000", "0012-0001", "0012-0002", "0012-0003", "0012-0004", "0012-0005")
  • Updated Step 4: Submit Trouble Ticket  - added information on ticket codes for Metro Connect to the following body parameters: code and details.

Updated information on Schedule Work Visit:
  • Now, customers no longer required to create order tickets for security access. 
  • If a visitor needs to be on-site for more than two weeks, they need to have IBX Data Center Access permissions and a completed Security Profile in the Equinix Customer Portal.
Billing_v2
GA
(update)

Added a new table Billing Invoice: API vs. Excel which shows the relationship between the billing API fields and the corresponding names on the Excel billing invoice.

Provided fixes for:  
  • GET Invoices - TaxInfo.value. Now, the value field is type of number
  • GET Invoices and GET Invoices Details - verified date format for TransactionDate and paymentDueDate response fields. Now, the format is YYYY-MM-DD.

Equinix Customer Portal - April 2021 R2021.04 Release Notes​

Release Overview
Release date: April 28, 2021
Introducing PurchaseOrders_v2 Beta API! With this new API, you can retrieve existing blanket purchase orders related to your account.
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
PurchaseOrders_v2 Beta
(new)

Introducing PurchaseOrders_v2 Beta.

With GET PurchaseOrders, you can retrieve a list of all existing blanket purchase orders for your account. Once you have retrieved this purchase order number, you can include it in your applicable order request.

Equinix Customer Portal - Promotion of ECP APIs from Beta to GA​

Release Overview
Release date: April 14, 2021
To view and download these newly promoted Equinix Customer Portal APIs, refer to the API Catalog.
To view the related Documentation, refer to the Summary below.

FeatureSummary of Release
Billing_v2,
CrossConnects_v2,
Lookup_v2,
Quotes_v2,
Resellers_v2,
Shipments_v2,
Users_v2, and
WorkVisits_v2		These APIs have been promoted from Beta to GA.

Equinix Customer Portal - March 2021 R2021.03 Release Notes​

Release Overview
Release date: March 25, 2021
In this release, we are introducing a new endpoint and method that supports new features, such as retrieval of your active Smart Hands™ support plans, and retrieval of all the existing portal users in your organization.
To view and download these updated and new Equinix Customer Portal APIs, refer to the API Catalog.
To view the related Documentation, refer to respective methods in the Summary below.

FeatureSummary of Release
SupportPlans_v2
Beta
(new)

Introducing SupportPlans_v2 Beta.

With GET SupportPlans you can retrieve a list of all your active Smart Hands support plans.
Users_v2
Beta
(update)		The new method, GET Users, allows you to retrieve a list of all existing portal users in your organization.

Equinix Customer Portal - February 2021 R2021.02 Release Notes​

Release Overview
Release date: February 15, 2021
This release includes new APIs such as Users_v2 Beta to support your organization's user management needs, and Billing_v2 Beta that allows retrieval of your billing document details.
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 API endpoints in the Summary below.

FeatureSummary of Release
Billing_v2 Beta
(new)

Introducing Billing_v2 Beta.

With these new endpoints, you can now achieve the following:Billing documents are currently supported in all regions (AMER, APAC, EMEA) except Brazil. For Brazil, please continue to refer to the Equinix Customer Portal for your billing details.
Users_v2 Beta
(new)

Introducing Users_v2 Beta.

Check out these new endpoints and their supported functions:

Equinix Customer Portal - January 2021 R2021.01 Release Notes​

Release Overview
Release date: January 28, 2021
As part of this release, we introduce the new Shipments_v2Beta API, and update the Lookup_v2Beta, Orders_v2 Beta, and Resellers_v2Beta APIs.
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 API endpoints in the Summary below.

FeatureSummary of Release
Lookup_v2
Beta
(update)

Added new ENUM value (SHIPMENTS) to query parameter permissionCode for GET Locations.

Introduced a new endpoint to support retrieving available connection services at an IBX: GET ConnectionServices.
Orders_v2
Beta
(update)		Orders_v2Beta API now supports inbound and outbound shipment orders. Refer to Orders (V2 Beta) methods for shipments-specific updates.
Resellers_v2
Beta
(update)

Added a new endpoint that enables immediate removal of a reseller customer account: POST Resellers {accountNumber} Customers {customerAccountNumber} Remove

The following method is no longer available: DELETE Resellers​ {accountNumber}​ Customers​ {customerAccountNumber}
Shipments_v2
Beta
(new)

Introduced Shipments_v2Beta.

With these new endpoints, you can now achieve the following: