Fabric overview

The Fabric v4 client: resources, method naming and the health check.

Entry point#

Fabric is the client for the Equinix Fabric v4 API, obtained from a session with eq.fabric() or constructed with new Fabric(credentials). The SDK tracks Fabric specification 4.34.0, read on 2026-11-11.

Resources#

Accessor	Covers	Page
`connections()`	Virtual connections, advertised and received routes, route-filter and route-aggregation attachments, validation	Connections
`ports()`, `portPackages()`	Ports, VLAN usage, LAG, port orders	Ports
`cloudRouters()`, `routingProtocols()`, `routeFilters()`, `routeFilterRules()`, `routeAggregations()`, `routeAggregationRules()`	Fabric Cloud Router and routing policy	Cloud Routers and routing
`serviceProfiles()`, `serviceTokens()`	Provider-side profiles and tokens	Service profiles and tokens
`streams()`, `streamSubscriptions()`, `streamAlertRules()`, `streamAssets()`, `metrics()`, `cloudEvents()`	Telemetry	Streams and observability
`precisionTimes()`	NTP and PTP time services	Precision Time
`networks()`	EVP-LAN, EP-LAN, EVP-Tree, EP-Tree and IP-WAN networks	Multi-metro WAN
`prices()`	Price search	Cost and value
`metros()`, `metroRegistry()`	Metros and inter-metro latency	Sessions
`marketplaceSubscriptions()`, `ipBlocks()`, `eiaServices()`, `companyProfiles()`, `tags()`, `agents()`, `agentTemplates()`	Smaller resources, same conventions	Javadoc
`beta()`	API families the specification labels Beta	Beta families

/fabric/v4/agents and /agentTemplates answered 200 on 2026-11-11 although the published specification omits them.

Method naming#

Client methods in every domain use these verbs.

Verb	Meaning
`list()`	`GET` collection
`search(...)`	`POST .../search` with filter and sort
`getByUuid(...)`	`GET` one resource
`define(...)`	Start a create builder; finish with `create()`
`update(...)`	Start an update builder; finish with `save()`
`delete(...)`	`DELETE`

The create builders are fluent and take enums where the specification defines an enumeration. For a mutable resource, the model object that the SDK returns also carries the operations: connection.update(), connection.delete() and connection.refresh() operate on the resource the object represents.

Health#

fabric.health() calls GET /fabric/v4/health.

Java

import com.eqixiac.equinix.fabric.model.HealthStatus;

HealthStatus health = fabric.health();
System.out.println(health.getState() + " " + health.getVersion());
health.getAllApiServices().forEach(service -> System.out.println(service));

The live service returns apiServices as an array, so getAllApiServices() returns all entries and getApiServices() returns the first.

Removed in 4.0#

Removed because Fabric v4 defines no such operation:

Removed	Replacement
`connections().getStatistics(...)`, `ports().getStatistics(...)` and the top-N port statistics listing	`fabric.metrics()`, see Observability
`connections().createBatch(...)`	Create connections one at a time. `POST /connections/bulk` has no path in the specification.
`RoutingProtocolBuilder.withEquinixAsn(...)`	None needed. Fabric assigns the ASN and returns it on `RoutingProtocol.getEquinixAsn()`.