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.


API Reference

NameSummary
Assets (V1)
Get Assets {assetId}Retrieve details of an asset by its ID
Search AssetsSearch permitted assets
Attachments (V1)
Upload Attachment FileUpload an attachment
Delete Attachment {attachmentId}Delete an attachment by its ID
Billing (V1)
Get AccountsRetrieve summary of permitted billing accounts
Get Accounts {accountNumber}Retrieve details of a permitted billing account by its number
Get Accounts {invoiceId}Download an invoice document by its ID
Billing (V2)
Get InvoicesRetrieve summary of billing documents (invoices and credit memos)
Get Invoices DetailsRetrieve details of billing documents (invoices and credit memos)
CrossConnects (V2)
Update Cross Connects {orderId}Partially update a cross connect order by its ID
Deinstall Cross ConnectsDeinstall cross connect assets
Create Cross ConnectsOrder single or multiple cross connects
To retrieve cross connect locations, connection services, patch panel and provider information, refer to Lookup (V2).
Lookup (V2)
Get Connection ServicesRetrieve all available connections services in an IBX
Get LocationsRetrieve all locations where user has related ordering permissions (applicable to A-side and Z-side locations for cross connects)
Get Patch PanelsRetrieve list of available patch panels (applicable to A-side and Z-side locations for cross connects)
Get Patch Panels {patchPanelId}Retrieve details of a patch panel by its ID (applicable to A-side and Z-side locations for cross connects)
Get ProvidersRetrieve available Z-side providers for your desired cross connect
Notifications (V1)
GET Notifications IBX {id}Retrieve details of IBX notification by its ID
Search for IBX NotificationsSearch for permitted IBX notifications
GET Notifications Network {id}Retrieve details of network notification by its ID
Search for Network NotificationsSearch for permitted network notifications
Order History (V1)
Get Orders History LocationsRetrieve all locations where order history can be viewed
Search Orders HistorySearch order history at permitted locations
Orders (V2 Beta)
Get Orders {orderId}Retrieve details of an order by its ID
Get Orders {orderId} NegotiationsRetrieve urgent negotiations for an order by its ID
Reply Orders {orderId} NegotiationsReply urgent negotiations for an order by its ID
Create Orders {orderId} NotesAdd notes to an order by its ID (notes includes additional information, attachments, or replies to Equinix technician's queries)
Cancel Orders {orderId}Cancel an order by its ID
Quotes (V2)
Get Quotes {quoteId}Retrieve details of a quote by its ID
Reports (V1)
Get ReportsRetrieve summary of generated reports
Get Reports FilesDownload a list of generated reports
Get Reports {reportId}Retrieve details of a generated report by its ID
Get Reports {reportId} FileDownload a generated report by its ID
Delete ReportsDelete a generated report
Get Reports SchedulerRetrieve summary of scheduled reports
Create Reports SchedulerRequest a new recurring or ad-hoc install base report
Delete Reports SchedulerDelete a scheduled report
Get Reports Scheduler {scheduleId}Retrieve details of a scheduled report by its ID
Create Reports Scheduler {scheduledId} ReportGenerate a scheduled report by its ID
Get Reports DefinitionsRetrieve names of report types and their corresponding parameters
Get Reports Definitions {reportName}Retrieve a report type and its corresponding parameters by its name
Shipments (V1)
Get Shipment LocationsRetrieve all locations where shipments may be scheduled
Create Inbound ShipmentSchedule an inbound shipment
Create Outbound ShipmentSchedule an outbound shipment
Shipments (V2)
Update Shipments {orderId}Partially update an inbound or outbound shipment order by its ID
Create ShipmentsSchedule an inbound or outbound shipment
To retrieve shipments location information, refer to Lookup (V2).
Smarthands (V1)
Get Smart Hands TypesRetrieve summary of the available Smart Hands types
Get Smart Hands LocationsRetrieve all locations where Smart Hands may be ordered
Create Smart Hands: Cage EscortOrder an IBX security escort for a visitor to access your cage
Create Smart Hands: Equipment InstallOrder an IBX Technician to install equipment
Create Smart Hands: Cage CleanupOrder trash removal or cage cleanup
Create Smart Hands: Shipment UnpackOrder inbound shipment unpacking and packaging disposal
Create Smart Hands: Cable RequestOrder cables per customer specifications
Create Smart Hands: Locate PackageOrder the location of your packages in the IBX
Create Smart Hands: Patch Cable InstallOrder installation of patch cables
Create Smart Hands: Patch Cable RemovalOrder removal of patch cable
Create Smart Hands: Pictures DocumentOrder an IBX technician to provide cage-related pictures or documentation
Create Smart Hands: Move Jumper CableOrder patch or jumper cables to be moved between devices
Create Smart Hands: Run Jumper CableOrder patch or jumper cables to be run between devices
Create Smart Hands: OtherOrder an unlisted Smart Hands order
SupportPlans (V2 Beta)
Get Support PlansRetrieve summary of Smart Hands support plans for the active months and year
Troubleticket (V1)
Get Trouble Ticket LocationsRetrieve all locations where trouble tickets may be submitted
Get Trouble Ticket TypesRetrieve all trouble ticket categories supported by Equinix
Create Trouble TicketSubmit a trouble ticket
Tickets (V2 Beta)
Get Tickets {id}Retrieve details of a trouble ticket by its ID
Update Tickets {id}Partially update a trouble ticket by its ID
Create Tickets {id} NotesAdd notes to a trouble ticket by its ID (this includes additional information, attachments, or replies to Equinix technician's queries)
Cancel Tickets {id}Cancel a trouble ticket by its ID
Create TicketsSubmit a trouble ticket
Users (V2)
Update Users {username}Modify the profile details of a user by their username
WorkVisits (V2)
Update Work Visits {orderId}Partially update a work visit order by its ID
Create Work VisitsSchedule a work visit to grant IBX visitors access for up to two weeks
To retrieve work visit locations information, refer to Lookup (V2).