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

Name
Description
Connections
Create Connection v4Creates 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 Connection v4Returns details for a specified connection.
Retrieve Connections v4Retrieves connections that match provided search criteria.
Update Connection v4Modifies connection parameters.
Manage Connection v4Enables approving/rejecting connections, approving/rejecting connection bandwidth update, accepting connection deletion, triggering BGP synchronization.
Delete Connection v4Deletes a specified connection.
Validate Connection Authorization Key v4Validates the authorization key required for establishing connections to cloud service providers.
Fabric Cloud Router
Create Fabric Cloud Router v4Creates a Fabric Cloud Router instance.
Get Specified Fabric Cloud Router v4Returns details of a specified Fabric Cloud Router instance.
Update Fabric Cloud Router v4Modifies a Fabric Cloud Router instance.
Manage Routing Tables v4Triggers update of the Fabric Cloud Router instance's routing tables.
Get Routing Tables Management Requests v4Retrieves routing tables management actions requests.
Retrieve Fabric Cloud Routers v4Retrieves Fabric Cloud Router instances that match provided search criteria.
Delete Fabric Cloud Router v4Deletes a Fabric Cloud Router instance.
Get All Fabric Cloud Router Packages v4Retrieves Fabric Cloud Router packages' details.
Get Specified Fabric Cloud Router Package v4Retrieves details of a specified Fabric Cloud Router package.
Metrics
Get Specified Port Statistics v4Provides key service-level traffic metrics needed to manage subscription sizing and capacity. Returns bandwidth utilization statistics about a specified port.
Get Ports Statistics v4Returns traffic statistics for ports in a specified metro.
Get Connection Statistics v4Provides key service-level traffic metrics needed to manage subscription sizing and capacity. Returns usage statistics for a specified connection.
Metros
Get All Metros v4Returns all metropolitan areas where Equinix Fabric is available, along with latency data for each location.
Get All Subscriber Metros v4Uses 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 Code v4Returns specified metropolitan area.
Ports
Create Port v4Creates a virtual Fabric port that can be used as an endpoint in virtual connections.
Create Pair of Redundant Ports v4Creates a pair of redundant Fabric ports that can be used as an endpoint in virtual connections.
Add Physical Ports to Virtual Port v4Adds physical ports to a virtual port.
Get All Ports v4Returns details of all assigned and available Equinix Fabric ports for the user's credentials.
Get Specified Port v4Returns details of a specific port.
Delete Specified Port v4Deletes a specific port.
Get Used Vlans v4Returns used vlans for a specified port.
Search Ports v4Finds ports based on a filtering criteria.
Pricing
Retrieve Pricing v4Retrieves pricing information for specified connections.
Routing Table Entries
Retrieve Routing Tables Entries v4Retrieves Fabric Cloud Router instances routing table entries that match provided search criteria.
Routing Protocols
Create Routing Protocol Instance v4Adds a single routing protocol definition to a given connection.
Create Routing Protocol Instances v4Adds routing protocol definitions to a given connection.
Get All Routing Protocol Instances v4Retrieves routing protocol definitions associated with a specified connection.
Get Specified Routing Protocol Instance v4Retrieves details of a specified routing protocol definition associated with a given connection.
Replace Routing Protocol Instance v4Replaces routing protocols.
Update Routing Protocol v4Enables or disables Ipv4 and Ipv6 protocols.
Get All Routing Protocol Change Requests v4Returns all change requests associated with a given routing protocol definition.
Get Specified Routing Protocol Change Request v4Returns the details of a specified routing protocol change request.
Clear or Reset BGP v4Clears or resets the BGP session of a routing protocol.
Get BGP Actions v4Returns BGP actions.
Get Specified BGP Action v4Returns BGP action for an action Id.
Delete Routing Protocol Instance v4Deletes a specified routing protocol definition associated with a given connection.
Validate Subnet v4Validates all subnets associated with a connection in the given FCR.
Service Profiles
Create Service Profile v4Creates a service profile, which enables other Platform Equinix participants to connect and subscribe to your services.
Get Service Profiles v4Retrieves service profiles available on Equinix Platform.
Get Specified Service Profile v4Retrieves a specified service profile.
Retrieve Service Profiles v4Retrieves service profiles that match the provided search criteria.
Update Service Profile v4Modifies service profile configuration.
Replace Service Profile v4Replaces a service profile definition.
Delete Service Profiles v4Deletes a service profile.
Service Tokens
Create Service Token v4Generates Equinix Fabric service tokens (both subscriber and provider side).
Get All Service Tokens v4Retrieves all service tokens associated with the specified account credentials.
Get Specified Service Token v4Uses 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 Tokens v4Removes the Equinix Fabric service token corresponding to the specified uuid.
Search for Service Tokens v4Finds all service tokens for a search criteria.
Fabric Networks
Create Fabric Network v4Creates a Fabric network instance.
Get Specified Fabric Network v4Returns details for the specified Fabric network instance.
Update Fabric Network v4Updates a Fabric network instance.
Retrieve Fabric Networks v4Returns Fabric network instances that match the specified criteria.
Delete Fabric Network v4Deletes a given Fabric network instance.
Get Connections Associated With Specified Fabric Network v4Returns connections associated with the specified Fabric network instance.
Get Fabric Network Changes v4Returns change log for a specified Fabric network instance.
Get Specified Fabric Network Change v4Returns a specified changelog item for a given Fabric network instance.
Precision Time
Get Time Service v4Returns precision time service details.
Delete Time Service v4Deletes a time service by its unique Id.
Patch Time Service v4Updates time service parameters by the unique Id of the service.
Create Time Service v4Creates a time service.
Route Filters
Create Route Filter v4Creates a Route Filter.
Get Route Filter v4Returns a Route Filter by its unique Id.
Search Route Filters v4Returns Route Filters that match the provided search criteria.
Patch Route Filter v4Updates a Route Filter partially.
Delete Route Filter v4Deletes a Route Filter by its unique Id.
Attach Route Filter To Connection v4Attaches a Route Filter to a connection.
Detach Route Filter From Connection v4Deletes a Route Filter attached to a connection.
Get Route Filter With Connection v4Returns a specific Route Filter attached to a connection.
Get Route Filters With Connection v4Returns all Route Filters attached to a connection.
Get Connections Of Route Filter v4Returns connections of a Route Filter Id.
Route Filter Rules
Create Route Filter Rule v4Creates a Route Filter Rule.
Create Route Filter Rules v4Creates Route Filter Rules in bulk.
Get Route Filter Rule v4Returns a specific Route Filter Rule by its unique Id.
Get Route Filter Rules v4Returns all Route Filter Rules for Fabric.
Patch Route Filter Rule v4Partially updates a Route Filter Rule.
Replace Route Filter Rule v4Completely updates a Route Filter Rule.
Delete Route Filter Rule v4Deletes a Route Filter Rule.