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.


ECP Permissions vs. APIs

In the Getting Started section you can find general information on required permissions to perform a variety of functions using ECP APIs.

The Equinix Customer Portal allows you to view and set Equinix permissions required for respective APIs. Learn how to manage ECP permissions and link them to APIs (refer to Mapping Permissions to APIs table for more information).

Manage ECP Permissions

  1. Log into the Equinix Customer Portal.
  • You need an account on the Equinix Customer Portal.
  • You need administrator access rights that allow you to view and set permissions.
  1. From the Administration drop-down menu, choose User Management.
    The User Management dashboard is displayed.
 

For a reseller organization, choose Reseller Customer Management. Refer to Manage End-Customer Permissions for more information.

ECPUserMgmt

  1. From the user list, locate the user you want to edit and click Options.

  2. Select Manage Permission from the list.

ECPUserMgmt-ManagePermissions 5. On the Permissions tab, click the card for which you want to view and set permissions.
The Permissions tab displays a catalog of permission types.

ECPUserMgmt-PermissionsTable

 

To request additional permissions, contact your ECP Master Administrator.

Mapping Permissions to APIs

The following table lists the ECP permissions you need to access the corresponding APIs.

API AccessRequired Permission
  • Assets API
  • Reports API
  • Install Base - View details and export reports on each product your organization has purchased
  • Cross Connect API
  • Lookup API
  • Orders API
  • Order History API
  • Shipments API
  • Smart Hands API
  • Tickets API
  • Trouble Ticket API
  • Ordering - Place orders on the Equinix Customer Portal and view order details
  • Work Visit API
  • Administration & IBX Access Services Request - Manage administrator rights to Equinix Customer Portal and Permission to raise scheduled IBX access service requests
  • Billing API
  • Billing and Payments - View financial records and payment history
  • Notification Management API
  • IBX Services Notifications - Subscribe to IBX, network, unannounced shipments, and managed services notifications
  • Support Plans API
  • Smart Hands Support Plan - Subscribe to notifications for your Smart Hands Support Plan.
    View and subscribe to Smart Hands Support Plan Notifications

    Note: If you already have smarthands ordering permissions, you do not require this permission card to retrieve smarthands plans