Equinix

Equinix Fabric API v4

Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to: 1. Cloud Service Providers - Clouds, network and other service providers. 2. Enterprises - Other Equinix customers, vendors and partners. 3. Myself - Another customer instance deployed at Equinix. Integrations (SDKs, Tools) links: Fabric Java SDK Fabric Go SDK Fabric Python SDK Equinix Terraform Provider Fabric Terraform Modules Equinix Pulumi Provider

Endpoints 274

ASNs

  • POSTCreate ASN/fabric/v4/asnsCreate a new Public or Private ASN record
  • POSTSearch ASNs/fabric/v4/asns/searchSearch for ASN records based on criteria
  • GETGet ASN/fabric/v4/asns/:asnIdRetrieve ASN record by UUID
  • DELETEDelete ASN/fabric/v4/asns/:asnIdDeprovision ASN record by UUID
  • PATCHUpdate ASN/fabric/v4/asns/:asnIdUpdate ASN record

Application Domains

  • POSTCreate Domain/fabric/v4/appDomainsThis API provides capability to create user's App Domain
  • GETGet Domain/fabric/v4/appDomains/:appDomainIdThis API provides capability to retrieve user's Domain
  • DELETEDelete Domain/fabric/v4/appDomains/:appDomainIdThis API provides capability to delete user's Domain
  • PATCHUpdate Domain/fabric/v4/appDomains/:appDomainIdThis API provides capability to update user's Domain
  • POSTSearch Domains/fabric/v4/appDomains/searchThe API provides capability to get list of user's App Domains using search criteria, including optional filtering, pagination and sorting
  • GETGet Attached Links for Domain/fabric/v4/appDomains/:appDomainId/appLinksThis API provides capability to retrieve App Links attached to an App Domain

Application Links

  • POSTCreate Link/fabric/v4/appLinksThis API provides capability to create user's Link
  • GETGet Link/fabric/v4/appLinks/:appLinkIdThis API provides capability to retrieve user's Link
  • DELETEDelete Link/fabric/v4/appLinks/:appLinkIdThis API provides capability to delete user's Link
  • PATCHUpdate Link/fabric/v4/appLinks/:appLinkIdThis API provides capability to update user's Link
  • POSTSearch Links/fabric/v4/appLinks/searchThe API provides capability to get list of user's App Links using search criteria, including optional filtering, pagination and sorting
  • GETGet Attached Domain for Link/fabric/v4/appLinks/:appLinkId/appDomains/:appDomainIdThis API provides ability to retrieve an App Domain attached to an App Link
  • PUTAttach Domain to Link/fabric/v4/appLinks/:appLinkId/appDomains/:appDomainIdThis API provides ability to attach the user's App Domain to App Link
  • DELETEDetach Domain from Link/fabric/v4/appLinks/:appLinkId/appDomains/:appDomainIdThis API provides ability to detach App Domain from App Link
  • POSTSearch Attached Domains for Link/fabric/v4/appLinks/:appLinkId/appDomains/searchThe API provides capability to get list of user's attached App Domains using search criteria, including optional filtering, pagination and sorting
  • GETGet Attached Domains for Link/fabric/v4/appLinks/:appLinkId/appDomainsThis API provides capability to retrieve App Domains attached to an App Link
  • GETGet Attached Service for Link/fabric/v4/appLinks/:appLinkId/appServices/:appServiceIdThis API provides ability to retrieve an App Service attached to an App Link
  • PUTAttach Service to Link/fabric/v4/appLinks/:appLinkId/appServices/:appServiceIdThis API provides ability to attach the user's App Service to App Link
  • DELETEDetach Service from Link/fabric/v4/appLinks/:appLinkId/appServices/:appServiceIdThis API provides ability to detach App Service from App Link
  • PATCHUpdate Service Attachment for Link/fabric/v4/appLinks/:appLinkId/appServices/:appServiceIdThis API provides ability to update the App Service attachment to App Link
  • POSTSearch Attached Services for Link/fabric/v4/appLinks/:appLinkId/appServices/searchThe API provides capability to get list of user's attached App Services using search criteria, including optional filtering, pagination and sorting
  • GETGet Attached Services for Link/fabric/v4/appLinks/:appLinkId/appServicesThis API provides capability to retrieve App Services attached to an App Link
  • GETGet attached App Processor for App Link/fabric/v4/appLinks/:appLinkId/appProcessors/:appProcessorIdThis API provides ability to get an App Processor attached to an App Link.
  • PUTAttach Processor to Link/fabric/v4/appLinks/:appLinkId/appProcessors/:appProcessorIdThis API provides ability to attach an App Processor to an App Link.
  • DELETEDetach App Processor from App Link/fabric/v4/appLinks/:appLinkId/appProcessors/:appProcessorIdThis API provides ability to detach an App Processor from an App Link.
  • POSTSearch attached Processors to Link/fabric/v4/appLinks/:appLinkId/appProcessors/searchThe API provides capability to get list of App Processors attached to an App Link using search criteria, including optional filtering, pagination and sorting
  • GETGet attached Processors for Link/fabric/v4/appLinks/:appLinkId/appProcessorsThis API provides capability to retrieve App Processors attached to an App Link.

Application Processors

  • GETGet Processor/fabric/v4/appProcessors/:appProcessorIdThis API provides capability to retrieve user's App Processor
  • POSTSearch Processors/fabric/v4/appProcessors/searchThe API provides capability to get list of user's App Processors using search criteria, including optional filtering, pagination and sorting

Application Services

  • POSTCreate Service/fabric/v4/appServicesThis API provides capability to create user's Service
  • GETGet Service/fabric/v4/appServices/:appServiceIdThis API provides capability to retrieve user's Service
  • DELETEDelete Service/fabric/v4/appServices/:appServiceIdThis API provides capability to delete user's Service
  • PATCHUpdate Service/fabric/v4/appServices/:appServiceIdThis API provides capability to update user's Service
  • POSTSearch Services/fabric/v4/appServices/searchThe API provides capability to get list of user's App Services using search criteria, including optional filtering, pagination and sorting
  • GETGet Attached Links for Service/fabric/v4/appServices/:appServiceId/appLinksThis API provides capability to retrieve App Links attached to an App Service
  • GETGet Attached Subscriptions for Service/fabric/v4/appServices/:appServiceId/appSubscriptionsThis API provides capability to retrieve App Subscriptions attached to an App Service
  • POSTSearch Attached Subscriptions/fabric/v4/appServices/:appServiceId/appSubscriptions/searchThe API provides capability to get list of App Subscriptions attached to an App Service using search criteria

Application Subscriptions

  • POSTCreate Subscription/fabric/v4/appSubscriptionsThis API provides capability to create user's Subscription
  • GETGet Subscription/fabric/v4/appSubscriptions/:appSubscriptionIdThis API provides capability to retrieve user's Subscription
  • DELETEDelete Subscription/fabric/v4/appSubscriptions/:appSubscriptionIdThis API provides capability to delete user's Subscription
  • PATCHUpdate Subscription/fabric/v4/appSubscriptions/:appSubscriptionIdThis API provides capability to update user's Subscription
  • POSTSearch Subscriptions/fabric/v4/appSubscriptions/searchThe API provides capability to get list of user's App Subscriptions using search criteria, including optional filtering, pagination and sorting

Events

  • GETGet Cloud Events by Asset Id (Deprecated)/fabric/v4/:asset/:assetId/cloudeventsDeprecated. This API provides capability to retrieve cloud events of an asset id
  • GETGet Cloud Event/fabric/v4/cloudevents/:cloudEventIdThis API provides capability to retrieve a cloud event by uuid
  • POSTSearch Cloud Events/fabric/v4/cloudevents/searchThis API provides capability to search cloud events from a filtered query
  • POSTSearch last Operational Cloud Events/fabric/v4/liveEvents/searchThis API provides capability to search last operational cloud events from a filtered query

Cloud Router Packages

  • GETList Packages/fabric/v4/routerPackagesThis API provides capability to retrieve user's Cloud Routers Packages
  • GETGet Package Details/fabric/v4/routerPackages/:routerPackageCodeThis API provides capability to retrieve user's Cloud Routers Package Details

Cloud Routers

  • POSTSearch Advertised Routes/fabric/v4/connections/:connectionId/advertisedRoutes/searchThe API provides capability to get list of user's advertised routes using search criteria, including optional filtering, pagination and sorting
  • POSTSearch Received Routes/fabric/v4/connections/:connectionId/receivedRoutes/searchThe API provides capability to get list of received routes using search criteria, including optional filtering, pagination and sorting
  • POSTCreate Router/fabric/v4/routersThis API provides capability to create user's Cloud Router
  • GETGet Router/fabric/v4/routers/:routerIdThis API provides capability to retrieve user's Cloud Router
  • DELETEDelete Router/fabric/v4/routers/:routerIdThis API provides capability to delete user's Cloud Router
  • PATCHUpdate Router/fabric/v4/routers/:routerIdThis API provides capability to update user's Cloud Router
  • GETGet Route Table Actions/fabric/v4/routers/:routerId/actionsThis API provides capability to fetch all actions for a given cloud router
  • POSTCreate Route Table Action/fabric/v4/routers/:routerId/actionsThis API provides capability to refresh route table and bgp session summary information
  • POSTSearch Route Table Actions/fabric/v4/routers/:routerId/actions/searchThis API provides capability to search route table actions for a given cloud router
  • GETGet Route Table Action by ID/fabric/v4/routers/:routerId/actions/:actionIdThis API provides capability to fetch action status
  • GETGet Commands/fabric/v4/routers/:routerId/commandsThis API provides capability to fetch all commands
  • POSTCreate Command/fabric/v4/routers/:routerId/commandsThis API provides capability to initiate Command
  • POSTSearch Commands/fabric/v4/routers/:routerId/commands/searchThis API provides capability to search commands
  • GETGet Command/fabric/v4/routers/:routerId/commands/:commandIdThis API provides capability to fetch command using command Id
  • DELETEDelete Command/fabric/v4/routers/:routerId/commands/:commandIdThis API provides capability to delete command based on command Id
  • POSTSearch Route Tables/fabric/v4/routers/:routerId/routes/searchThe API provides capability to get list of user's Fabric Cloud Router route table entries using search criteria, including optional filtering, pagination and…
  • POSTSearch Routers/fabric/v4/routers/searchThe API provides capability to get list of user's Cloud Routers using search criteria, including optional filtering, pagination and sorting

Company Profiles

  • POSTCreate Company Profile/fabric/v4/companyProfilesCreate a new company profile <font color="red"> <sup color='red'>Beta</sup></font>
  • GETGet Company Profile by ID/fabric/v4/companyProfiles/:companyProfileIdGet company profile details by UUID <font color="red"> <sup color='red'>Beta</sup></font>
  • DELETEDelete Company Profile/fabric/v4/companyProfiles/:companyProfileIdDelete company profile by UUID <font color="red"> <sup color='red'>Beta</sup></font>
  • POSTSearch Company Profiles/fabric/v4/companyProfiles/searchSearch company profiles based on filter criteria <font color="red"> <sup color='red'>Beta</sup></font>
  • GETGet Service Profiles/fabric/v4/companyProfiles/:companyProfileId/serviceProfilesGet all service profiles attached to a company profile <font color="red"> <sup color='red'>Beta</sup></font>
  • PUTAttach Service Profile/fabric/v4/companyProfiles/:companyProfileId/serviceProfiles/:serviceProfileIdAttach a service profile to a company profile <font color="red"> <sup color='red'>Beta</sup></font>
  • DELETEDetach Service Profile/fabric/v4/companyProfiles/:companyProfileId/serviceProfiles/:serviceProfileIdDetach a service profile from a company profile <font color="red"> <sup color='red'>Beta</sup></font>
  • GETGet Tags/fabric/v4/companyProfiles/:companyProfileId/tagsGet all tags attached to a company profile <font color="red"> <sup color='red'>Beta</sup></font>
  • PUTAttach Tag/fabric/v4/companyProfiles/:companyProfileId/tags/:tagIdAttach a tag to a company profile <font color="red"> <sup color='red'>Beta</sup></font>
  • DELETEDetach Tag/fabric/v4/companyProfiles/:companyProfileId/tags/:tagIdDetach a tag from a company profile <font color="red"> <sup color='red'>Beta</sup></font>
  • GETGet Private Services/fabric/v4/companyProfiles/:companyProfileId/privateServicesGet all private services attached to a company profile <font color="red"> <sup color='red'>Beta</sup></font>
  • PUTAttach Private Service/fabric/v4/companyProfiles/:companyProfileId/privateServices/:privateServiceIdAttach a private service to a company profile <font color="red"> <sup color='red'>Beta</sup></font>
  • DELETEDetach Private Service/fabric/v4/companyProfiles/:companyProfileId/privateServices/:privateServiceIdDetach a private service from a company profile <font color="red"> <sup color='red'>Beta</sup></font>

Connections

  • POSTCreate Connection/fabric/v4/connectionsThis API provides capability to create user's virtual connection
  • GETGet Connection by ID/fabric/v4/connections/:connectionIdThe API provides capability to get user's virtual connection details (Service Tokens, Access Points, Link Protocols, etc) by it's connection ID (UUID)
  • DELETEDelete Connection by ID/fabric/v4/connections/:connectionIdDelete Connection by ID
  • PATCHUpdate Connection by ID/fabric/v4/connections/:connectionIdUpdate Connection by ID
  • POSTCreate Connection Action/fabric/v4/connections/:connectionId/actionsThis API provides capability to accept/reject user's virtual connection
  • POSTSearch Connections/fabric/v4/connections/searchThe API provides capability to get list of user's virtual connections using search criteria, including optional filtering, pagination and sorting
  • POSTValidate Connection/fabric/v4/connections/validateThis API provides capability to validate by auth key

Cross Connects

  • POSTCreate Cross Connect/fabric/v4/crossConnectsThe API provides capability to create a new Cross Connect.
  • POSTCreate Diverse Cross Connect/fabric/v4/crossConnects/bulkThe API provides capability to create several Cross Connects in a single order - a diverse pair where the PRIMARY and the SECONDARY Cross Connect are placed…
  • POSTSearch Cross Connects/fabric/v4/crossConnects/searchThe API provides capability to get list of user's Cross Connects using search criteria, including optional filtering, pagination and sorting.
  • GETGet Cross Connect/fabric/v4/crossConnects/:crossConnectIdThe API provides capability to get Cross Connect details by Cross Connect ID.
  • GETGet Cross Connect Schedules/fabric/v4/crossConnects/:crossConnectId/schedulesThe API provides capability to get the schedules of a Cross Connect by Cross Connect ID.
  • GETGet Cross Connect Services/fabric/v4/crossConnects/:crossConnectId/servicesThe API provides capability to get the services ordered alongside a Cross Connect by Cross Connect ID.
  • GETGet Cross Connect Attachments/fabric/v4/crossConnects/:crossConnectId/attachmentsThe API provides capability to get the documents attached to a Cross Connect by Cross Connect ID.
  • GETGet Cross Connect Notes/fabric/v4/crossConnects/:crossConnectId/notesThe API provides capability to get the notes added to a Cross Connect by Cross Connect ID.
  • POSTCross Connect Actions/fabric/v4/crossConnects/:crossConnectId/actionsThe API provides capability to perform an action on a Cross Connect that is in the PENDING_ACTION state. The applicable action types are listed in the…
  • GETGet Cross Connect Action by Action ID/fabric/v4/crossConnects/:crossConnectId/actions/:actionIdThe API provides capability to fetch Cross Connect action details by Action ID.
  • POSTSearch Cross Connect Actions/fabric/v4/crossConnects/:crossConnectId/actions/searchThe API provides capability to get list of Cross Connect Actions using search criteria, including optional filtering, pagination and sorting.
  • POSTSearch Cross Connect Schedules/fabric/v4/crossConnectSchedules/searchThe API provides capability to search the Cross Connect schedule windows offered at an IBX, including optional filtering, pagination and sorting.

Health

  • GETGet Service Status/fabric/v4/healthRetrieves the operational health status of all Equinix Fabric services, enabling customers to monitor service availability and detect potential disruptions…

Internet Exchange Services

  • POSTCreate Internet Exchange Service/fabric/v4/exchangeServicesThis API provides capability to create Internet Exchange Service
  • GETGet Internet Exchange Service/fabric/v4/exchangeServices/:exchangeServiceIdThe API provides capability to get Internet Exchange Service
  • PATCHUpdate Internet Exchange Service/fabric/v4/exchangeServices/:exchangeServiceIdThe API provides capability to update Internet Exchange Service
  • POSTSearch Internet Exchange Services/fabric/v4/exchangeServices/searchThe API provides capability to get list of user's Internet Exchange Service using search criteria, including optional filtering, pagination and sorting
  • POSTCreate Internet Exchange Service Action/fabric/v4/exchangeServices/:exchangeServiceId/actionsThis API provides capability to perform actions on Internet Exchange Service

Internet Access Services

  • POSTCreate Internet Access Service/fabric/v4/internetAccessServicesCreates Internet Access Service
  • POSTSearch Internet Access Services/fabric/v4/internetAccessServices/searchSearch for Internet Access Services
  • GETGet Internet Access Service by ID/fabric/v4/internetAccessServices/:uuidRetrieve Internet Access Service by UUID
  • DELETEDelete Internet Access Service by ID/fabric/v4/internetAccessServices/:uuidDelete Internet Access Service by UUID
  • PATCHUpdate Internet Access Service by ID/fabric/v4/internetAccessServices/:uuidPatch Internet Access Service by UUID

IP Blocks

  • POSTCreate IP Block/fabric/v4/ipBlocksSubmits new Equinix owned or customer owned IP Block request
  • GETRetrieve IP Block by ID/fabric/v4/ipBlocks/:uuidRetrieve IP Block by UUID
  • DELETEDelete IP Block by ID/fabric/v4/ipBlocks/:uuidDelete IP Block by UUID
  • PATCHUpdate IP Block by ID/fabric/v4/ipBlocks/:uuidpatch IP Block by UUID
  • POSTSearch IP Blocks/fabric/v4/ipBlocks/searchSearch for IP Blocks based on criteria

Loas

  • POSTCreate Loa/fabric/v4/loasThe API provides capability to create a new Loa
  • GETGet Loa/fabric/v4/loas/:loaIdThe API provides capability to get Loa details by Loa ID
  • PATCHUpdate Loa/fabric/v4/loas/:loaIdThe API provides capability to update Loa details by Loa ID
  • POSTCreate LOA Action/fabric/v4/loas/:loaId/actionsThe API provides capability to perform actions on Loa
  • GETGet Loa Action by Action ID/fabric/v4/loas/:loaId/actions/:actionIdThis API provides capability to fetch action details
  • POSTSearch Loas/fabric/v4/loas/searchThe API provides capability to get list of user's Loa using search criteria, including optional filtering, pagination and sorting
  • POSTSearch Loa Actions/fabric/v4/loas/:loaId/actions/searchThe API provides capability to get list of user's Loa Actions using search criteria, including optional filtering, pagination and sorting
  • GETGet Loa Consumers/fabric/v4/loas/:loaId/consumersThe API provides capability to get Loa consumers by Loa ID
  • GETGet Loa Notes/fabric/v4/loas/:loaId/notesThe API provides capability to get Loa notes by Loa ID
  • POSTCreate Loa Note/fabric/v4/loas/:loaId/notesThe API provides capability to create Loa note by Loa ID

Logos

  • POSTCreate Logo/fabric/v4/logosCreate Logo for Equinix Fabric™ Company Profile
  • GETGet Logo/fabric/v4/logos/:uuidGet Logo by UUID
  • DELETEDelete Logo/fabric/v4/logos/:uuidDelete Logo by UUID

Marketplace Subscriptions

  • GETGet Subscription/fabric/v4/marketplaceSubscriptions/:subscriptionIdThe API provides capability to get subscription

Metrics

  • GETGet Metrics by Asset Id (Deprecated)/fabric/v4/:asset/:assetId/metrics?name=equinix.fabric.connection.bandwidth_rx.usageDeprecated. This API provides capability to retrieve Metrics of an asset id
  • GETGet Metrics by Name/fabric/v4/metrics?name=equinix.fabric.metro.*.latency&value=lastThis API provides capability to retrieve Metrics by specific wildcard metric types
  • POSTSearch Metrics/fabric/v4/metrics/searchThis API provides capability to search metrics from a filtered query

Metros

  • GETGet Metros/fabric/v4/metrosGET All Subscriber Metros with an option query parameter to return all Equinix Fabric metros in which the customer has a presence, as well as latency data for…
  • GETGet Metro by Code/fabric/v4/metros/:metroCodeGET Metros retrieves all Equinix Fabric metros, as well as latency data between each metro location

Networks

  • POSTCreate Network/fabric/v4/networksThis API provides capability to create user's Fabric Network
  • GETGet Network By ID/fabric/v4/networks/:networkIdThis API provides capability to retrieve user's Fabric Network
  • DELETEDelete Network By ID/fabric/v4/networks/:networkIdThis API provides capability to delete user's Fabric Network
  • PATCHUpdate Network By ID/fabric/v4/networks/:networkIdThis API provides capability to update user's Fabric Network
  • POSTSearch Networks/fabric/v4/networks/searchThe API provides capability to search user's Fabric Network using search criteria, including optional filtering, pagination and sorting
  • GETGet Connections/fabric/v4/networks/:networkId/connectionsThe API provides capability to get list of user's Fabric Network connections
  • GETGet Network Changes/fabric/v4/networks/:networkId/changesThe API provides capability to get list of user's Fabric Network changes
  • GETGet Change By ID/fabric/v4/networks/:networkId/changes/:changeIdThis API provides capability to retrieve user's Fabric Network Change

Optical Metro Connects

  • POSTCreate Optical Metro Connect Service/fabric/v4/opticalConnectsCreate a single Optical Metro Connect circuit.
  • POSTCreate Dual Diverse Optical Metro Connect Service/fabric/v4/opticalConnects/bulkCreate a dual diverse pair of circuits on separate optical paths.
  • GETGet Optical Metro Connect Service/fabric/v4/opticalConnects/:opticalConnectIdGet a single Optical Metro Connect by UUID.
  • POSTSearch Optical Metro Connect Services/fabric/v4/opticalConnects/searchGet Optical Metro Connects matching the supplied criteria, with optional filtering, pagination and sorting.

Port Packages

  • GETList Port Packages/fabric/v4/portPackagesGet All Port Packages returns details of all available port packages for the specified user credentials

Ports

  • GETGet All Ports/fabric/v4/portsGet All Ports returns details of all assigned and available ports for the specified user credentials. The metro attribute in the response shows the origin of…
  • POSTCreate Port/fabric/v4/portsCreates Equinix Fabric™ Port
  • POSTAdd to Lag/fabric/v4/ports/:portId/physicalPorts/bulkAdd Physical Ports to Virtual Port.<font color="red"> <sup color='red'>Preview</sup></font>
  • GETGet Port by ID/fabric/v4/ports/:portIdGet Port by ID returns details of assigned and available Equinix Fabric port for the specified user credentials. The metro code attribute in the response…
  • DELETEDelete Port/fabric/v4/ports/:portIdThe API provides capability to delete a single port
  • PATCHUpdate Port by ID/fabric/v4/ports/:portIdUpdate Port by UUID
  • GETGet Vlans/fabric/v4/ports/:portUuid/linkProtocolsThe API provides capability to retrieve Vlans for a Port
  • POSTSearch Ports/fabric/v4/ports/searchThe API provides capability to get list of user's virtual ports using search criteria, including optional filtering, pagination and sorting

Precision Time Packages

  • GETGet Packages/fabric/v4/timeServicePackagesThe API provides capability to get timing service's packages
  • GETGet Package By Code/fabric/v4/timeServicePackages/:packageCodeThe API provides capability to get timing service's package by code

Precision Time Services

  • POSTCreate Time Service/fabric/v4/timeServicesThe API provides capability to create Precision Time service
  • GETGet Time Service by ID/fabric/v4/timeServices/:serviceIdThe API provides capability to get Precision Time Service details
  • PUTUpdate Time Service/fabric/v4/timeServices/:serviceIdThe API provides capability to Configure/Fulfill the Precision Time Service
  • DELETEDelete Time Service by ID/fabric/v4/timeServices/:serviceIdThe API provides capability to delete Precision Time Service by service id
  • PATCHUpdate Time Service by ID/fabric/v4/timeServices/:serviceIdThe API provides capability to update Precision Time Service by service id
  • POSTSearch Time Services/fabric/v4/timeServices/searchThe API provides capability to get list of user's Time Services using search criteria, including optional filtering, pagination and sorting
  • GETGet Connection Links/fabric/v4/timeServices/:serviceId/connectionsThe API provides capability to get prevision timing service's details

Prices

  • POSTSearch Prices/fabric/v4/prices/searchSearch prices by search criteria

Route Aggregation Rules

  • GETGet Route Aggregation Rules/fabric/v4/routeAggregations/:routeAggregationId/routeAggregationRulesThis API provides capability to get all Route Aggregations Rules for Fabric
  • POSTCreate Route Aggregation Rule/fabric/v4/routeAggregations/:routeAggregationId/routeAggregationRulesThis API provides capability to create a Route Aggregation Rule
  • GETGet Route Aggregation Rule by ID/fabric/v4/routeAggregations/:routeAggregationId/routeAggregationRules/:routeAggregationRuleIdThis API provides capability to view a Route Aggregation Rule by UUID
  • PUTReplace Route Aggregation Rule/fabric/v4/routeAggregations/:routeAggregationId/routeAggregationRules/:routeAggregationRuleIdThis API provides capability to replace a Route Aggregation Rule completely
  • DELETEDelete Route Aggregation Rule/fabric/v4/routeAggregations/:routeAggregationId/routeAggregationRules/:routeAggregationRuleIdThis API provides capability to delete a Route aggregation Rule
  • PATCHUpdate Route Aggregation Rule/fabric/v4/routeAggregations/:routeAggregationId/routeAggregationRules/:routeAggregationRuleIdThis API provides capability to partially update a Route Aggregation Rule
  • GETGet Route Aggregation Rule Changes/fabric/v4/routeAggregations/:routeAggregationId/routeAggregationRules/:routeAggregationRuleId/changesThis API provides capability to retrieve all of a Route Aggregation Rule's Changes
  • GETGet Change By ID/fabric/v4/routeAggregations/:routeAggregationId/routeAggregationRules/:routeAggregationRuleId/changes/:changeIdThis API provides capability to retrieve a specific Route Aggregation Rule's Changes
  • POSTBulk Create Route Aggregation Rules/fabric/v4/routeAggregations/:routeAggregationId/routeAggregationRules/bulkThis API provides capability to create bulk route aggregation rules
  • POSTSearch Route Aggregation Rules/fabric/v4/routeAggregations/:routeAggregationId/routeAggregationRules/searchThis API provides capability to search Route Aggregation Rules

Route Aggregations

  • GETGet Connection Route Aggregations/fabric/v4/connections/:connectionId/routeAggregationsThis API provides capability to view all Route Aggregations attached to a Connection
  • GETGet Aggregation/fabric/v4/connections/:connectionId/routeAggregations/:routeAggregationIdThis API provides capability to view a specific Route Aggregation attached to a Connection
  • PUTAttach Aggregation/fabric/v4/connections/:connectionId/routeAggregations/:routeAggregationIdThis API provides capability to attach a Route Aggregation to a Connection
  • DELETEDetach Aggregation/fabric/v4/connections/:connectionId/routeAggregations/:routeAggregationIdThis API provides capability to detach a Route Aggregation from a Connection
  • POSTCreate Route Aggregation/fabric/v4/routeAggregationsThis API provides capability to create a Route Aggregation
  • GETGet Aggregation/fabric/v4/routeAggregations/:routeAggregationIdThis API provides capability to view a Route Aggregation by UUID
  • DELETEDelete Aggregation/fabric/v4/routeAggregations/:routeAggregationIdThis API provides capability to delete a Route Aggregation
  • PATCHUpdate Route Aggregation/fabric/v4/routeAggregations/:routeAggregationIdThis API provides capability to partially update a Route Aggregation
  • GETGet Route Aggregation Changes/fabric/v4/routeAggregations/:routeAggregationId/changesThis API provides capability to retrieve all of a Route Aggregation's Changes
  • GETGet Change By ID/fabric/v4/routeAggregations/:routeAggregationId/changes/:changeIdThis API provides capability to retrieve a specific Route Aggregation's Changes
  • GETGet Route Aggregation Connections/fabric/v4/routeAggregations/:routeAggregationId/connectionsThis API provides capability to view all Connections using the Route Aggregation
  • POSTSearch Route Aggregations/fabric/v4/routeAggregations/searchThis API provides capability to search Route Aggregations
  • POSTSearch Cloud Router Route Aggregation Attachments/fabric/v4/routers/:routerId/routeAggregations/searchThis API provides capability to search route aggregation attachments for a given cloud router <font color="red"> <sup color='red'>Beta</sup></font>

Route Filter Rules

  • GETGet Route Filter Rules/fabric/v4/routeFilters/:routeFilterId/routeFilterRulesThis API provides capability to get all Route Filters Rules for Fabric
  • POSTCreate Route Filter Rule/fabric/v4/routeFilters/:routeFilterId/routeFilterRulesThis API provides capability to create a Route Filter Rule
  • GETGet Route Filter Rule by ID/fabric/v4/routeFilters/:routeFilterId/routeFilterRules/:routeFilterRuleIdThis API provides capability to view a Route Filter Rule by UUID
  • PUTReplace Route Filter Rule/fabric/v4/routeFilters/:routeFilterId/routeFilterRules/:routeFilterRuleIdThis API provides capability to replace a Route Filter Rule completely
  • DELETEDelete Route Filter Rule/fabric/v4/routeFilters/:routeFilterId/routeFilterRules/:routeFilterRuleIdThis API provides capability to delete a Route Filter Rule
  • PATCHUpdate Route Filter Rule/fabric/v4/routeFilters/:routeFilterId/routeFilterRules/:routeFilterRuleIdThis API provides capability to partially update a Route Filter Rule
  • GETGet Route Filter Rule Changes/fabric/v4/routeFilters/:routeFilterId/routeFilterRules/:routeFilterRuleId/changesThis API provides capability to retrieve all of a Route Filter Rule's Changes
  • GETGet Change By ID/fabric/v4/routeFilters/:routeFilterId/routeFilterRules/:routeFilterRuleId/changes/:changeIdThis API provides capability to retrieve a specific Route Filter Rule's Changes
  • POSTBulk Create Route Filter Rules/fabric/v4/routeFilters/:routeFilterId/routeFilterRules/bulkThis API provides capability to create bulk route filter rules
  • POSTSearch Route Filter Rules/fabric/v4/routeFilters/:routeFilterId/routeFilterRules/searchThis API provides capability to search Route Filter Rules

Route Filters

  • GETGet Connection Route Filters/fabric/v4/connections/:connectionId/routeFiltersThis API provides capability to view all Route Filters attached to a Connection
  • GETGet Route Filter/fabric/v4/connections/:connectionId/routeFilters/:routeFilterIdThis API provides capability to view a specific Route Filter attached to a Connection
  • PUTAttach Route Filter/fabric/v4/connections/:connectionId/routeFilters/:routeFilterIdThis API provides capability to attach a Route Filter to a Connection
  • DELETEDetach Route Filter/fabric/v4/connections/:connectionId/routeFilters/:routeFilterIdThis API provides capability to detach a Route Filter from a Connection
  • POSTCreate Route Filter/fabric/v4/routeFiltersThis API provides capability to create a Route Filter
  • GETGet Route Filter by ID/fabric/v4/routeFilters/:routeFilterIdThis API provides capability to view a Route Filter by UUID
  • DELETEDelete Route Filter/fabric/v4/routeFilters/:routeFilterIdThis API provides capability to delete a Route Filter
  • PATCHUpdate Route Filter/fabric/v4/routeFilters/:routeFilterIdThis API provides capability to partially update a Route Filter
  • GETGet Route Filter Changes/fabric/v4/routeFilters/:routeFilterId/changesThis API provides capability to retrieve all of a Route Filter's Changes
  • GETGet Change By ID/fabric/v4/routeFilters/:routeFilterId/changes/:changeIdThis API provides capability to retrieve a specific Route Filter's Changes
  • GETGet All Connections on Route Filter/fabric/v4/routeFilters/:routeFilterId/connectionsThis API provides capability to view all Connections using the Route Filter
  • POSTSearch Route Filters/fabric/v4/routeFilters/searchThis API provides capability to search Route Filters
  • POSTSearch Cloud Router Route Filter Attachments/fabric/v4/routers/:routerId/routeFilters/searchThis API provides capability to search route filter attachments for a given cloud router <font color="red"> <sup color='red'>Beta</sup></font>

Routing Protocols

  • GETGet Routing Protocols/fabric/v4/connections/:connectionId/routingProtocolsThis API provides capability to get Routing Protocols for connections
  • POSTCreate Routing Protocol/fabric/v4/connections/:connectionId/routingProtocolsThis API provides capability to create Routing Protocol for connections
  • POSTBulk Create Routing Protocols/fabric/v4/connections/:connectionId/routingProtocols/bulkThis API provides capability to create Routing Protocol for connections
  • GETGet Protocol/fabric/v4/connections/:connectionId/routingProtocols/:routingProtocolIdThis API provides capability to accept/reject user's virtual connection
  • PUTReplace Protocol/fabric/v4/connections/:connectionId/routingProtocols/:routingProtocolIdThis API provides capability to replace complete Routing Protocols on a virtual connection
  • DELETEDelete Protocol/fabric/v4/connections/:connectionId/routingProtocols/:routingProtocolIdThis API provides capability to delete Routing Protocols on virtual connection
  • PATCHPatch Protocol/fabric/v4/connections/:connectionId/routingProtocols/:routingProtocolIdThis API provides capability to partially update Routing Protocols on a virtual connection
  • GETGet BGP Actions/fabric/v4/connections/:connectionId/routingProtocols/:routingProtocolId/actionsThis API provides capability to get all BGP actions status
  • POSTClear/Reset BGP/fabric/v4/connections/:connectionId/routingProtocols/:routingProtocolId/actionsThis API provides capability to clear/reset Routing Protocols BGP session
  • GETGet BGP Action/fabric/v4/connections/:connectionId/routingProtocols/:routingProtocolId/actions/:actionIdThis API provides capability to retrieve specific BGP action
  • GETGet Change By ID/fabric/v4/connections/:connectionId/routingProtocols/:routingProtocolId/changes/:changeIdThis API provides capability to retrieve specific Routing Protocol Change
  • GETGet Routing Protocol Changes/fabric/v4/connections/:connectionId/routingProtocols/:routingProtocolId/changesThis API provides capability to retrieve user's Routing Protocol Changes
  • POSTValidate Subnet/fabric/v4/routers/:routerId/validateThis API provides capability to validate all subnets associated with any connection in the given FCR

Service Profiles

  • GETList Service Profiles/fabric/v4/serviceProfilesThe API request returns all Equinix Fabric Service Profiles in accordance with the view point requested
  • POSTCreate Service Profile/fabric/v4/serviceProfilesCreate Service Profile creates Equinix Fabric™ Service Profile
  • POSTSearch Service Profiles/fabric/v4/serviceProfiles/searchSearch service profiles by search criteria
  • GETGet Service Profile/fabric/v4/serviceProfiles/:serviceProfileIdGet service profile by UUID. View Point parameter if set to zSide will give seller's view of the profile otherwise buyer's view
  • PUTReplace Service Profile/fabric/v4/serviceProfiles/:serviceProfileIdThis API request replaces a service profile definition
  • DELETEDelete Service Profile/fabric/v4/serviceProfiles/:serviceProfileIddelete Service Profile by UUID
  • PATCHUpdate Service Profile/fabric/v4/serviceProfiles/:serviceProfileIdUpdate Service Profile by UUID
  • POSTCreate Service Profile Action/fabric/v4/serviceProfiles/:serviceProfileId/actionsThis API provides capability to accept/reject service profile update requests
  • GETGet Service Profile Environments/fabric/v4/serviceProfiles/:serviceProfileId/environmentsGet service profile provider environments by UUID <sup color='red'>Beta</sup></font>
  • POSTCreate Service Profile Environment Action/fabric/v4/serviceProfiles/:serviceProfileId/environments/:environmentId/actionsThis API provides capability to perform actions on a service profile environment, such as validating an activation key.<sup color='red'>Beta</sup></font>
  • GETGet Service Profile Metros/fabric/v4/serviceProfiles/:serviceProfileId/metrosGet service profile metros by UUID

Service Tokens

  • GETGet Service Token by ID/fabric/v4/serviceTokens/:serviceTokenIdGet Specified Service Tokens uses the uuid of an Equinix Fabric service token to return details about the token's type, state, location, bandwidth, and other…
  • DELETEDelete Service Token by ID/fabric/v4/serviceTokens/:serviceTokenIdDelete Service Tokens removes an Equinix Fabric service token corresponding to the specified uuid which are in INACTIVE state
  • PATCHUpdate Token By ID/fabric/v4/serviceTokens/:serviceTokenIdThis API provides capability to update user's Service Token
  • GETGet Service Tokens/fabric/v4/serviceTokensGet All ServiceTokens creates a list of all Equinix Fabric service tokens associated with the subscriber's account.
  • POSTCreate Service Token/fabric/v4/serviceTokensCreate Service Tokens generates Equinix Fabric™ service tokens. These tokens authorize users to access protected resources and services.
  • POSTCreate Service Token Action/fabric/v4/serviceTokens/:serviceTokenId/actionsThis API provides capability to accept/reject user's servicetokens
  • POSTSearch Service Tokens/fabric/v4/serviceTokens/searchThe API provides capability to get list of user's servicetokens using search criteria, including optional filtering, pagination and sorting

Statistics

  • GETGet Stats by ID (DEPRECATED)/fabric/v4/ports/:portId/stats?startDateTime=2020-11-06T07:00:00Z&endDateTime=2020-11-10T07:00:00ZDeprecated. This API provides service-level traffic metrics so that you can view access and gather key information required to manage service subscription…
  • GETGet Stats by ID (DEPRECATED)/fabric/v4/connections/:connectionId/stats?startDateTime=2020-11-06T07:00:00Z&endDateTime=2020-11-10T07:00:00Z&viewPoint=aSideDeprecated. This API provides service-level metrics so that you can view access and gather key information required to manage service subscription sizing and…

Stream Alert Rules

  • GETGet Stream Alert Rules/fabric/v4/streams/:streamId/alertRulesThis API provides capability to retrieve stream alert rules
  • POSTCreate Stream Alert Rule/fabric/v4/streams/:streamId/alertRulesThis API provides capability to create user's Stream Alert Rules
  • GETGet Stream Alert Rule/fabric/v4/streams/:streamId/alertRules/:alertRuleIdThis API provides capability to get user's stream alert rule
  • PUTUpdate Stream Alert Rule/fabric/v4/streams/:streamId/alertRules/:alertRuleIdThis API provides capability to update a user's stream alert rule
  • DELETEDelete Stream Alert Rule/fabric/v4/streams/:streamId/alertRules/:alertRuleIdThis API provides capability to delete a user's stream alert rule

Stream Subscriptions

  • GETGet Subscriptions/fabric/v4/streams/:streamId/subscriptionsThis API provides capability to retrieve stream subscriptions
  • POSTCreate Subscription/fabric/v4/streams/:streamId/subscriptionsThis API provides capability to create user's Stream Subscriptions
  • GETGet Subscription/fabric/v4/streams/:streamId/subscriptions/:subscriptionIdThis API provides capability to delete user's get Stream Subscriptions
  • PUTUpdate Subscription/fabric/v4/streams/:streamId/subscriptions/:subscriptionIdThis API provides capability to update user's Stream Subscriptions
  • DELETEDelete Subscription/fabric/v4/streams/:streamId/subscriptions/:subscriptionIdThis API provides capability to delete user's Stream Subscriptions
  • POSTSearch Stream Subscriptions/fabric/v4/streamSubscriptions/searchThis API provides capability to search stream subscriptions

Streams

  • GETGet Streams/fabric/v4/streamsThis API provides capability to retrieve streams
  • POSTCreate Stream/fabric/v4/streamsThis API provides capability to create user's stream
  • POSTSearch Streams/fabric/v4/streams/searchThis API provides capability to search streams
  • GETGet Stream/fabric/v4/streams/:streamIdThis API provides capability to get user's stream
  • PUTUpdate Stream/fabric/v4/streams/:streamIdThis API provides capability to update user's stream
  • DELETEDelete Stream/fabric/v4/streams/:streamIdThis API provides capability to delete user's stream
  • POSTSearch Stream Assets/fabric/v4/streamAssets/searchThis API provides capability to search stream assets
  • GETGet Asset/fabric/v4/streams/:streamId/:asset/:assetIdThis API provides capability to get user's assets attached to a stream
  • PUTAttach Asset/fabric/v4/streams/:streamId/:asset/:assetIdThis API provides capability to attach an asset to a stream
  • DELETEDetach Asset/fabric/v4/streams/:streamId/:asset/:assetIdThis API provides capability to detach an asset from a stream
  • GETGet Network Edge Device/fabric/v4/streams/:streamId/devices/:deviceIdThis API provides capability to get a Network Edge Device and its interfaces attached to a stream
  • PUTAttach Network Edge Device Interfaces/fabric/v4/streams/:streamId/devices/:deviceIdThis API provides capability to attach a Network Edge Device and its interfaces to a stream. The provided interfaces list is the complete desired set:…
  • DELETEDetach Network Edge Device/fabric/v4/streams/:streamId/devices/:deviceIdThis API provides capability to detach a Network Edge Device and all of its interfaces from a stream

Tags

  • GETList Tags/fabric/v4/tagsGet all Tags
  • POSTCreate Tag/fabric/v4/tagsCreate Tag for Equinix Fabric™
  • GETGet Tag/fabric/v4/tags/:uuidGet Tag by UUID

API details

Base URL
https://api.equinix.com
Authentication
A bearer token in the Authorization header
Operations
274 operations on 188 pathsGET 106POST 93DELETE 35PATCH 22PUT 18
4 marked deprecated
Main resources
Application Links 21Cloud Routers 17Company Profiles 13Route Aggregations 13Route Filters 13Routing Protocols 13Streams 13Cross Connects 12Service Profiles 11Loas 10
Response formats
application/json application/json; charset=utf-8 multipart/mixed
Description format
OpenAPI 3.0.3, API version 4.34.0

How to test the Equinix Fabric API v4 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Equinix Fabric API v4 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create ASN” (POST /fabric/v4/asns), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Equinix Fabric API v4?

Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed… It is listed under Developer tools and has 274 endpoints.

Who publishes the Equinix Fabric API v4?

It is listed from Equinix's public API description (an OpenAPI document), not published by Equinix on Swastik Codes. Anyone who controls equinix.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Equinix Fabric API v4?

Requests go to https://api.equinix.com. Endpoint paths are added to this base URL.

How do I authenticate with the Equinix Fabric API v4?

With A bearer token in the Authorization header.

How many endpoints does the Equinix Fabric API v4 have?

274 operations on 188 paths (106 GET, 93 POST, 35 DELETE, 22 PATCH, 18 PUT). The largest groups are Application Links, Cloud Routers, Company Profiles, Route Aggregations.

Is forking the Equinix Fabric API v4 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.