Skip to main content
Index

API Reference

 

 

 Name  Summary
Setup (V1) 
Get Device Types  Returns all available device types on the Network Edge platform. 
Get Available Metros  Returns all available metros on the Network Edge platform. 
Get Accounts {metro}  Returns all available billing accounts of an organization. 
Get Agreement Status  Checks the validity of a customer's agreement. 
Create Agreement  Creates an agreement between a customer and Network Edge. 
Get Vendor Terms  Returns a link to the terms of the vendor of your virtual device, e.g. Cisco, Juniper, or others.
Get Order Terms  Returns the order and vendor-specific terms and conditions.
Get Price  Checks the price of a virtual device or the price of additional services for an existing virtual device. 
Get Order Summary  Returns an Equinix order summary as a printable pdf file. 
Get Public Keys  Returns public keys associated with the user's organization. 
Create Public Key  Posts a keyName and keyValue pair. 
 
Licensing (V1) 
Post License File  Posts a license file from your vendor in case you want to bring your own license (BYOL) for a new virtual device.
Post License {uuid}  Re-posts a license file in case a provisioned device experiences a license registration failure. 
Update License  Update a license token/code/ID in case your license fails to register at the time of device creation.
 
Virtual Devices (V1) 
Get Virtual Devices  Returns the details of all virtual devices on the Network Edge platform. 
Get Virtual Device {uuid}  Returns the details of a virtual device on the Network Edge platform. 
Create Equinix-Configured Device  Create an Equinix-configured device. 
Create Self-Configured Device  Create a self-configured device. 
Create SDWAN Device  Create an SDWAN device. 
Create Cluster Device  Create a cluster device. 
Update Device Draft  Updates a draft device. 
Get Device Interfaces  Returns the status of the interfaces of a device. 
Update Additional Bandwidth  Updates the additional bandwidth of an existing device or adds additional bandwidth to an existing device. 
Ping Virtual Device  Pings a virtual device to ensure it is reachable. 
Delete Virtual Devices  Deletes virtual devices on the Network Edge platform. 
Update Virtual Device  Updates the name, term length, status, and notification list of a device. 
   
Layer 2 Connections & Service Profiles (V1) 
Get L2 Service Profiles  Gets all available L2 seller profiles.
Get L2 Service Profiles {uuid}  Gets an L2 Service Profile by its uuid. 
Validate L2 Authorization Key  Validates an L2 service key against an L2 destination service profile. 
Get L2 Connection  Returns an L2 connection by its unique ID. 
Connect to AWS  Establish a connection between your Equinix virtual device and AWS Direct Connect. 
Connect to Azure  Establish a connection between your Equinix virtual device and Azure Express Route. 
Connect to Google  Establish a connection between your Equinix virtual device and Google cloud platform. 
Connect to Oracle  Establish a connection between your Equinix virtual device and Oracle FastConnect. 
Delete Connection {uuid}  Deletes a connection by its unique ID. 
 
Device Link (V1) 
Get Device Link  Returns device link groups.
Create Device Link  Creates a device link between provisioned virtual devices. 
Get Device Link {uuid}  Returns a device link group by its unique ID. 
Update Device Link  Updates a device link group. 
Delete Device Link  Deletes a device link group. 
 
BGP (V1) 
Get BGP Peerings  Returns BGP configurations.
Get BGP Peering {uuid}  Returns a BGP configuration by its uuid. 
Create BGP Peering  Establish a point-to-point connection between your virtual device and your cloud service provider. 
Update BGP Peering  Updates the BGP peering between a virtual device and a cloud service provider. 
 
VPN (V1) 
Get VPN Configurations  Returns VPNs.
Get VPN Configuration {uuid}  Returns the details of a VPN configuration by its unique ID. 
Create VPN  Enable VPN for Equinix-configured devices. 
Update VPN Configuration  Updates a VPN configuration. 
Delete VPN Configuration  Deletes a VPN configuration by its unique ID. 
 
ACL Template (V1) 
Get ACL Template  Returns the details of device ACL templates.
Get ACL Template {uuid}  Returns the details of an ACL template. 
Create ACL Template  Creates an ACL template. 
Update ACL Template  Updates an ACL template. 
Delete ACL Template {uuid}  Deletes an ACL template
Post DNS Lookup  Looks up IP addresses associated with domains of a metro or a virtual device. 
 
SSH User (V1) 
Get SSH Users  Returns SSH user details. 
Get SSH User {uuid}  Returns the SSH user details by the unique ID of an SSH user. 
Create SSH User  Creates a new SSH user and associates it to a virtual device. You can only associate a user with an active device. 
Update SSH User {uuid}  Associates a device to an SSH user. 
Update SSH User Password  Updates the password of an SSH user. 
Delete SSH User  Dissociates an SSH user from a  device. The user will be if there is no other device associated with it. 
 
Device Backup & Restore (V1) 
Get Backups of Device  Returns the backups of a virtual device. 
Get Backups of Device {uuid}  Returns the details of a backup.
Download a Backup  Downloads the backup in the format of a string. 
Create Device Backup  Creates the backup of a device.
Update Device Backup  Updates the name of a backup. 
Delete Backup of Device  Deletes a backup by its unique ID. 
Check Feasibility of Restore  Checks the feasibility of restoring the backup of a virtual device. 
Restore a Backup  Restores a Backup 

 

Postman Scripts