API Reference
Name
|
Description
|
---|---|
Connections | |
Create Connectionv4
|
Creates a connection to cloud service providers, your colocation assets or other third-parties present on Equinix Platform using service tokens, invitations or generic service profiles. |
Get Specified Connectionv4
|
Returns details for a specified connection. |
Retrieve Connectionsv4
|
Retrieves connections that match provided search criteria. |
Update Connectionv4
|
Modifies connection parameters. |
Manage Connectionv4
|
Enables approving/rejecting connections, approving/rejecting connection bandwidth update, accepting connection deletion, triggering BGP synchronization. |
Delete Connectionv4
|
Deletes a specified connection. |
Validate Connection Authorization Keyv4
|
Validates the authorization key required for establishing connections to cloud service providers. |
Fabric Cloud Router | |
Create Fabric Cloud Routerv4
|
Creates a Fabric Cloud Router instance. |
Get Specified Fabric Cloud Routerv4
|
Returns details of a specified Fabric Cloud Router instance. |
Update Fabric Cloud Routerv4
|
Modifies a Fabric Cloud Router instance. |
Manage Routing Tablesv4
|
Triggers update of the Fabric Cloud Router instance's routing tables. |
Get Routing Tables Management Requestsv4
|
Retrieves routing tables management actions requests. |
Get Routing Tables Management Requests by Idv4
|
Returns routing tables management actions requests by Action Id. |
Search Routing Tables Management Requestsv4
|
Searches routing tables management actions requests. |
Get Routing Tables Management Requests by Idv4
|
Retrieves routing tables management action requests by Action Id. |
Search Routing Tables Management Requestsv4
|
Searches through routing tables management action requests. |
Retrieve Fabric Cloud Routersv4
|
Retrieves Fabric Cloud Router instances that match provided search criteria. |
Delete Fabric Cloud Routerv4
|
Deletes a Fabric Cloud Router instance. |
Get All Fabric Cloud Router Packagesv4
|
Retrieves Fabric Cloud Router packages' details. |
Get Specified Fabric Cloud Router Packagev4
|
Retrieves details of a specified Fabric Cloud Router package. |
Metrics | |
Get Specified Port Statisticsv4
|
Provides key service-level traffic metrics needed to manage subscription sizing and capacity. Returns bandwidth utilization statistics about a specified port. |
Get Ports Statisticsv4
|
Returns traffic statistics for ports in a specified metro. |
Get Connection Statisticsv4
|
Provides key service-level traffic metrics needed to manage subscription sizing and capacity. Returns usage statistics for a specified connection. |
Metros | |
Get All Metrosv4
|
Returns all metropolitan areas where Equinix Fabric is available, along with latency data for each location. |
Get All Subscriber Metrosv4
|
Uses the /fabric/v4/metros endpoint with an option query parameter to return all metropolitan areas in which the customer has a presence, as well as latency data for each location. |
Get Metros by Metro Codev4
|
Returns specified metropolitan area. |
Ports | |
Create Portv4
|
Creates a virtual Fabric port that can be used as an endpoint in virtual connections. |
Create Pair of Redundant Portsv4
|
Creates a pair of redundant Fabric ports that can be used as an endpoint in virtual connections. |
Add Physical Ports to Virtual Portv4
|
Adds physical ports to a virtual port. |
Get All Portsv4
|
Returns details of all assigned and available Equinix Fabric ports for the specified user credentials. |
Get Specified Portv4
|
Returns details for the port corresponding to the specified uuid. |
Delete Specified Portv4
|
Deletes a specific port. |
Get Used Vlansv4
|
Returns used vlans for a specified port. |
Search Portsv4
|
Finds ports based on a filtering criteria. |
Pricing | |
Retrieve Pricingv4
|
Retrieves pricing information for specified connections. |
Routing Table Entries | |
Retrieve Routing Tables Entriesv4
|
Retrieves Fabric Cloud Router instances routing table entries that match provided search criteria. |
Search Received Routes for Connectionv4
|
Searches Received Routes, both active and inactive routes, for connection. |
Search Advertised Routes for Connectionv4
|
Searches Advertised Routes for connection. |
Routing Protocols | |
Create Routing Protocol Instancev4
|
Adds a single routing protocol definition to a given connection. |
Create Routing Protocol Instancesv4
|
Adds routing protocol definitions to a given connection. |
Get All Routing Protocol Instancesv4
|
Retrieves routing protocol definitions associated with a specified connection. |
Get Specified Routing Protocol Instancev4
|
Retrieves details of a specified routing protocol definition associated with a given connection. |
Replace Routing Protocol Instancev4
|
Replaces routing protocols. |
Update Routing Protocolv4
|
Enables or disables Ipv4 and Ipv6 protocols. |
Get All Routing Protocol Change Requestsv4
|
Returns all change requests associated with a given routing protocol definition. |
Get Specified Routing Protocol Change Requestv4
|
Returns the details of a specified routing protocol change request. |
Clear or Reset BGPv4
|
Clears or resets the BGP session of a routing protocol. |
Get BGP Actionsv4
|
Returns BGP actions. |
Get Specified BGP Actionv4
|
Returns BGP action for an action Id. |
Delete Routing Protocol Instancev4
|
Deletes a specified routing protocol definition associated with a given connection. |
Validate Subnetv4
|
Validates all subnets associated with a connection in the given FCR. |
Service Profiles | |
Create Service Profilev4
|
Creates a service profile, which enables other Platform Equinix participants to connect and subscribe to your services. |
Get Service Profilesv4
|
Retrieves service profiles available on Equinix Platform. |
Get Specified Service Profilev4
|
Retrieves a specified service profile. |
Retrieve Service Profilesv4
|
Retrieves service profiles that match the provided search criteria. |
Update Service Profilev4
|
Modifies service profile configuration. |
Replace Service Profilev4
|
Replaces a service profile definition. |
Delete Service Profilesv4
|
Deletes a service profile. |
Service Tokens | |
Create Service Tokenv4
|
Generates Equinix Fabric service tokens (both subscriber and provider side). |
Get All Service Tokensv4
|
Retrieves all service tokens associated with the specified account credentials. |
Get Specified Service Tokenv4
|
Uses the uuid of an Equinix Fabric service token to return details about the token's type, state, location, bandwidth, and other key attributes. |
Delete Specified Service Tokensv4
|
Removes the Equinix Fabric service token corresponding to the specified uuid. |
Search for Service Tokensv4
|
Finds all service tokens for a search criteria. |
Fabric Networks | |
Create Fabric Networkv4
|
Creates a Fabric network instance. |
Get Specified Fabric Networkv4
|
Returns details for the specified Fabric network instance. |
Update Fabric Networkv4
|
Updates a Fabric network instance. |
Retrieve Fabric Networksv4
|
Returns Fabric network instances that match the specified criteria. |
Delete Fabric Networkv4
|
Deletes a given Fabric network instance. |
Get Connections Associated With Specified Fabric
Networkv4
|
Returns connections associated with the specified Fabric network instance. |
Get Fabric Network Changesv4
|
Returns change log for a specified Fabric network instance. |
Get Specified Fabric Network Changev4
|
Returns a specified changelog item for a given Fabric network instance. |
Precision Time | |
Get Time Servicev4
|
Returns precision time service details. |
Delete Time Servicev4
|
Deletes a time service by its unique Id. |
Patch Time Servicev4
|
Updates time service parameters by the unique Id of the service. |
Create Time Servicev4
|
Creates a time service. |
Route Filters | |
Create Route Filter v4 |
Creates a Route Filter. |
Get Route Filter v4 |
Returns a Route Filter by its unique Id. |
Search Route Filters v4 |
Returns Route Filters that match the provided search criteria. |
Patch Route Filter v4 |
Updates a Route Filter partially. |
Delete Route Filter v4 |
Deletes a Route Filter by its unique Id. |
Attach Route Filter To Connection v4 |
Attaches a Route Filter to a connection. |
Detach Route Filter From Connection v4 |
Deletes a Route Filter attached to a connection. |
Get Route Filter With Connection v4 |
Returns a specific Route Filter attached to a connection. |
Get Route Filters With Connection v4 |
Returns all Route Filters attached to a connection. |
Get Connections Of Route Filter v4 |
Returns connections of a Route Filter Id. |
Route Filter Rules | |
Create Route Filter Rule v4 |
Creates a Route Filter Rule. |
Create Route Filter Rules v4 |
Creates Route Filter Rules in bulk. |
Get Route Filter Rule v4 |
Returns a specific Route Filter Rule by its unique Id. |
Get Route Filter Rules v4 |
Returns all Route Filter Rules for Fabric. |
Patch Route Filter Rule v4 |
Partially updates a Route Filter Rule. |
Replace Route Filter Rule v4 |
Completely updates a Route Filter Rule. |
Delete Route Filter Rule v4 |
Deletes a Route Filter Rule. |