API Reference

Name Summary
Assets (V1)
Get Assets {assetId} Retrieve details of an asset by its ID
Search Assets Search permitted assets
Attachments (V1)
Upload Attachment File Upload an attachment
Delete Attachment {attachmentId} Delete an attachment by its ID
Billing (V1)
Get Accounts Retrieve 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 Invoices Retrieve summary of billing documents (invoices and credit memos)
Get Invoices Details Retrieve 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 Connects Deinstall cross connect assets
Create Cross Connects Order 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 Services Retrieve all available connections services in an IBX
Get Locations Retrieve all locations where user has related ordering permissions (applicable to A-side and Z-side locations for cross connects)
Get Patch Panels Retrieve 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 Providers Retrieve 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 Notifications Search for permitted IBX notifications
GET Notifications Network {id} Retrieve details of network notification by its ID
Search for Network Notifications Search for permitted network notifications
Order History (V1)
Get Orders History Locations Retrieve all locations where order history can be viewed
Search Orders History Search order history at permitted locations
Orders (V2 Beta)
Get Orders {orderId} Retrieve details of an order by its ID
Get Orders {orderId} Negotiations Retrieve urgent negotiations for an order by its ID
Reply Orders {orderId} Negotiations Reply urgent negotiations for an order by its ID
Create Orders {orderId} Notes Add 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 Reports Retrieve summary of generated reports
Get Reports Files Download a list of generated reports
Get Reports {reportId} Retrieve details of a generated report by its ID
Get Reports {reportId} File Download a generated report by its ID
Delete Reports Delete a generated report
Get Reports Scheduler Retrieve summary of scheduled reports
Create Reports Scheduler Request a new recurring or ad-hoc install base report
Delete Reports Scheduler Delete a scheduled report
Get Reports Scheduler {scheduleId} Retrieve details of a scheduled report by its ID
Create Reports Scheduler {scheduledId} Report Generate a scheduled report by its ID
Get Reports Definitions Retrieve 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 Locations Retrieve all locations where shipments may be scheduled
Create Inbound Shipment Schedule an inbound shipment
Create Outbound Shipment Schedule an outbound shipment
Shipments (V2)
Update Shipments {orderId} Partially update an inbound or outbound shipment order by its ID
Create Shipments Schedule an inbound or outbound shipment
To retrieve shipments location information, refer to Lookup (V2).
Smarthands (V1)
Get Smart Hands Types Retrieve summary of the available Smart Hands types
Get Smart Hands Locations Retrieve all locations where Smart Hands may be ordered
Create Smart Hands: Cage Escort Order an IBX security escort for a visitor to access your cage
Create Smart Hands: Equipment Install Order an IBX Technician to install equipment
Create Smart Hands: Cage Cleanup Order trash removal or cage cleanup
Create Smart Hands: Shipment Unpack Order inbound shipment unpacking and packaging disposal
Create Smart Hands: Cable Request Order cables per customer specifications
Create Smart Hands: Locate Package Order the location of your packages in the IBX
Create Smart Hands: Patch Cable Install Order installation of patch cables
Create Smart Hands: Patch Cable Removal Order removal of patch cable
Create Smart Hands: Pictures Document Order an IBX technician to provide cage-related pictures or documentation
Create Smart Hands: Move Jumper Cable Order patch or jumper cables to be moved between devices
Create Smart Hands: Run Jumper Cable Order patch or jumper cables to be run between devices
Create Smart Hands: Other Order an unlisted Smart Hands order
SupportPlans (V2 Beta)
Get Support Plans Retrieve summary of Smart Hands support plans for the active months and year
Troubleticket (V1)
Get Trouble Ticket Locations Retrieve all locations where trouble tickets may be submitted
Get Trouble Ticket Types Retrieve all trouble ticket categories supported by Equinix
Create Trouble Ticket Submit 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} Notes Add 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 Tickets Submit 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 Visits Schedule a work visit to grant IBX visitors access for up to two weeks
To retrieve work visit locations information, refer to Lookup (V2).