All Classes and Interfaces
Class
Description
Address of an access point (spec 4.34.0
Address, sent on AccessPoint.address,
for example by the last-mile Colo2Sp-LMaaS-Primary example).E-Tree network connection role for an access point.
Values of the Fabric v4
AccessPointType schema (spec 4.34.0, catalog fetched
2026-11-11), plus AccessPointType.CHAINGROUP, which AccessPointType does not list but
VirtualConnectionPriceAccessPointType (price search) does.A-side access point type of an Equinix Internet Access (EIA) v1 connection (spec schema
AccessPointType): colocation (COLO) or virtual device (VD).A project-scoped IAM access policy - a set of permissions that may be granted to principals,
groups or other projects.
Internal client for project-scoped IAM access policies and their grants
(
/v1/projects/{projectId}/accessPolicies).Internal client implementation for project-scoped IAM access policies and their grants.
A grant associating a grantee (a principal, group or project) with an IAM access policy, as
returned by the grant operations (
GET .../accessPolicies/{accessPolicyId}/grants,
operationId listGrants; POST .../grants, operationId addGrant).Read-only JSON model for the IAM
AccessPolicyGrant response.Token-paginated JSON model for the IAM
AccessPolicyGrantList response schema.Read-only JSON model for the IAM
AccessPolicy response.Token-paginated JSON model for the IAM
AccessPolicyList response schema.AC power circuit configuration in a secure cabinet product availability response
(
AcCircuitConfig schema).A full account (the Fabric v4
SimplifiedAccount schema).Billing/organization account associated with an Equinix Internet Access (EIA) v2 service.
An agreement associated with an Equinix Internet Access (EIA) v1 account at an IBX, as returned
by
GET /internetAccess/v1/accounts/{accountNumber}/agreements.Read-only JSON model for an
AccountAgreement returned by the Equinix Internet Access (EIA)
v1 account-agreements lookup (GET /internetAccess/v1/accounts/{accountNumber}/agreements).Billing data for an Equinix Internet Access (EIA) v1 account
(
GET /internetAccess/v1/accounts).Internal client for the Equinix Internet Access (EIA) v1 account lookups:
GET /internetAccess/v1/accounts, GET /internetAccess/v1/accounts/{accountNumber}
and GET /internetAccess/v1/accounts/{accountNumber}/agreements.Internal client implementation for the Equinix Internet Access (EIA) v1 account lookups
(
GET /internetAccess/v1/accounts, GET /internetAccess/v1/accounts/{accountNumber}
and GET /internetAccess/v1/accounts/{accountNumber}/agreements).An Equinix Internet Access (EIA) v1 billing account, as returned by the account lookups
GET /internetAccess/v1/accounts and GET /internetAccess/v1/accounts/{accountNumber}.Read-only JSON model for an
AccountDetails returned by the Equinix Internet Access (EIA)
v1 account lookups — the list (GET /internetAccess/v1/accounts) and the single-account
get (GET /internetAccess/v1/accounts/{accountNumber}).The listAccounts endpoint returns a
PageResponseMetroAccountResponse object
({accountCreateUrl, pagination, data:[...]}); the account list is carried under the
data property.An operational unit (its IBXs and metros) within an Equinix Internet Access (EIA) v1 account
(
GET /internetAccess/v1/accounts).An IBX entry within an Equinix Internet Access (EIA) v1 account operational unit
(
GET /internetAccess/v1/accounts).A metro entry within an Equinix Internet Access (EIA) v1 account operational unit
(
GET /internetAccess/v1/accounts).Billing-account status of a Network Edge metro account (spec
MetroAccountResponse.accountStatus).An account summary (the Fabric v4
SimplifiedAccount schema).A single ACL association, pairing an existing ACL template (
uuid) with the device
interface (ACLInterfaceType) it should be applied to.The interface an ACL template applies to when associating it with a virtual device,
either the management (
MGMT) or WAN (WAN) interface.Client interface for managing Access Control List (ACL) templates on Network Edge devices.
Token-paginated JSON model for the IAM
ActionList response schema.The activation key of the Connection Coordinator specification
(
environment.yaml#/ActivationKey): the token a customer obtains from one provider and
enters at the other provider to accept a connection.A key this SDK release cannot interpret.
The Jackson serializer of every variant: it writes the empty object
{} and nothing
else, so no key material reaches JSON produced by any ObjectMapper, including one
with SerializationFeature.FAIL_ON_EMPTY_BEANS enabled (the default).A version 1 key: all members in cleartext.
Builder for a version 1 key.
A version 2 key: the envelope in cleartext, everything else encrypted for the destination
environment.
The Fabric v4
ActivationKeyDetails schema.Request body for adding a grant to an IAM access policy via
POST
/v1/projects/{projectId}/accessPolicies/{accessPolicyId}/grants (operationId addGrant,
spec schema AddGrantBody).A product-specific
{key, value} entry, reserved for additional product information on
quotes (additionalInfo) and orders (productAdditionalInfo).A postal address on a Customer Portal resource.
Administrative state of a specification resource (
common.yaml#/AdminState); carried by
Connection.adminState and FeatureGuidance.channelAdminState, both output only.A Fabric agent (for example an Autonomous Network Operations agent).
An activity (operation) performed by a Fabric agent.
Chat transcript and tool-call information captured during an agent operation
(spec schema
AgentActivities_metadata).Chat messages exchanged during an agent operation (spec schema
ChatMessage).A single chat message in an agent activity transcript (spec schema
Messages_inner).An agent's configuration (spec schema
Configuration).Definition document reference of an agent template (spec schema
AgentDefinition):
the URL of the template's ReadMe (.md) definition.Fluent builder/updater for Fabric agents.
Reference to the agent that performed an activity (spec schema
Agent).Client interface for managing Equinix Fabric agents.
Values of the
state property of the Fabric v4 Agents and AgentTemplates schemas.An Equinix-provided template that defines a class of Fabric agents.
Internal client for Fabric Agent Templates (read-only).
Reference to the agent template an agent was created from (spec schema
AgentTemplate).Client interface for querying Equinix Fabric agent templates (read-only).
A tool invocation made during an agent operation (spec schema
ToolCallInformation_inner).Status of an agreement-acceptance request (spec
AgreementAcceptResponse.status: SUCCESS /
FAILED).The type of agreement associated with an Equinix Internet Access (EIA) account at an IBX, as
returned by
GET /internetAccess/v1/accounts/{accountNumber}/agreements.A streaming alarm message describing a triggered condition for an IBX asset,
including its severity, threshold, current value and lifecycle status.
Identifies the asset associated with an
Alarm, including its type and
classification.The current measured value reported by an
Alarm, including its unit and value
type.The streaming envelope wrapping an
Alarm payload, carrying the message type
and its data.The lifecycle status of an
Alarm, indicating whether it has been
acknowledged, cleared and whether it is currently active.Identifies the monitoring tag associated with an
Alarm.The threshold definition that an
Alarm breached, including its unit, state
limit and descriptive message.A streaming alert message describing a notable event for an IBX asset, including the
event type, associated asset, tag and threshold details.
Identifies the asset associated with an
Alert, including its type and
classification.The alert configuration that produced a system alert (
ConfigurationReadModel in the spec).Lifecycle state of a power alert configuration (spec schema
AlertConfigurationReadModel,
property state).The streaming envelope wrapping an
Alert payload, carrying the message type
and its data.Processing timestamps for a system alert state change (
ProcessingTimeReadModel in the spec).Status of a SmartView alert or power event (spec schemas
AlertReadModel and
PowerEventReadModel, property status).Identifies the monitoring tag associated with an
Alert.The threshold definition associated with an
Alert, including its unit and the
minimum, maximum and current values.AllowedInterfaceProfile class.
AllowedInterfaceResponse class.
Error Response with details
ApiErrorAdditionalInfo model.
Contract for types usable as a query/path parameter value - the type constraint on the SDK's
parameter-building helpers (
ParameterMapper/ModelUtils), so arbitrary objects
cannot end up on a request URI.Available services details of the Fabric health endpoint (the Fabric v4
ApiServices
schema): the service route, its status and when that status last changed.App Domain object
App Link object
Current state of latest AppDomain change
App Domain change operation data
operation type applied to the resource
Current outcome of the change flow
Type of change
Create App Domain
Application Connect domains (6 operations).
Implementation of
AppDomains over the shared FabricBeta apiParams area.App Domain lifecycle state
App Domain Type
App Link object
App Link Attached App Domain object
App Link Attached App Processor object
App Link Attached App Service object
Current state of latest AppLink change
Current outcome of the change flow
Type of change
App Domain object associated with App Link
App Service object associated with App Link
Attach App Processor to App Link
Attach App Service to App Link
App Link attachment lifecycle state
Current state of latest AppLink change
App Link change operation data
operation type applied to the resource
Current outcome of the change flow
Type of change
App Link Cloud Router
Cloud Router Type
Create App Link
Cloud Router reference for App Link
Application Connect links and their domain, service and processor attachments (21 operations).
Implementation of
AppLinks over the shared FabricBeta apiParams area.App Link lifecycle state
App Link Type
App Processor object
Current state of latest AppProcessor change
App Processor change operation data
operation type applied to the resource
Current outcome of the change flow
Type of change
App Processor marketplace settings
App Processor marketplace visibility
Application Connect processors (2 operations).
Implementation of
AppProcessors over the shared FabricBeta apiParams area.App Processor lifecycle state
App Processor Type
App Service object
App Link object
App Subscription object attached to an App Service
Current state of latest AppService change
App Service change operation data
operation type applied to the resource
Current outcome of the change flow
Type of change
Create App Service
Application Connect services (8 operations).
Implementation of
AppServices over the shared FabricBeta apiParams area.App Service lifecycle state
App Service Type
App Subscription object
Current state of latest AppSubscription change
App Subscription change operation data
operation type applied to the resource
Current outcome of the change flow
Type of change
Create App Subscription
Prioritization strategy for forwarding API requests
Application Connect subscriptions (5 operations).
Implementation of
AppSubscriptions over the shared FabricBeta apiParams area.Source details for the Subscription
App Link reference for App Subscription
Source details for the Subscription
App Link reference for App Subscription
App Subscription lifecycle state
Target details for the Subscription
App Service reference for App Subscription
Target details for the Subscription
App Service reference for App Subscription
App Subscription Type
ASN Record
Asset associated with ASN
AsnAssetIpBlockRef model.
AsnAssetIpBlockRefType values.
Associated Internet Access Service reference
AsnAssetServiceType values.
Change reference for ASN
Ownership challenge details for public ASN verification
Type of ownership challenge
ASN range selection
Regional Internet Registry region
Autonomous System Numbers (ASNs): public and private ASN records (5 operations).
Implementation of
Asns over the shared FabricBeta apiParams area.ASN lifecycle state
An installed-base asset retrieved from the Equinix Customer Portal Assets v1 API: a product or
piece of equipment belonging to the organization that is installed in an Equinix IBX.
Additional asset details specific to an asset (
AdditionalDetails schema).Asset details (including the asset's tag points) for a single asset, wrapped in the
payLoad/status envelope returned by the asset/details GET endpoint
(AssetDetailsGetResponse in the spec).Deserialization holder for the asset/details GET response (
AssetDetailsGetResponse).Asset details payload including the asset's tag points (AssetDetails in the spec).
Typed request body for the asset/details POST endpoint (AssetDetailsRequest = GenericRequest + assetIds).
The multi-asset details returned by the asset/details POST endpoint, wrapped in the
payLoad/status envelope (AssetDetailsResponse in the spec).The
payLoad of an AssetDetailsResponse.Deserialization holder for the asset/details POST response (
AssetDetailsResponse).An asset element within an asset-list template, including alarm and resiliency status.
JSON model for an installed-base asset (
asset/assetsSummary schema, Assets v1 API).An
asset message-type entry within a subscription's MessageType.Product type used when filtering an asset search (
filter.productTypes).A key/value pair representing a single asset product detail (
AssetsProperty schema).Client interface for accessing asset information in the Equinix Customer Portal.
The asset search results returned by the asset/search endpoint, wrapped in the
payLoad/status envelope (Assets in the spec).The
payLoad of an Assets search response.A single asset element returned by the asset search endpoint.
Installed-date range filter on an asset search (
filter.dateRange).Filter for an asset search (
filter object of AssetsSearchRequest).Request for searching assets (
POST /v1/assets/search, AssetsSearchRequest).Fields an asset search free-text query (
q) is matched against (source query
parameter of POST /v1/assets/search, Assets v1 spec).Deserialization holder for the asset/search response (
Assets).The hierarchical (category / template / asset) assets list returned by the asset/list endpoint,
wrapped in the
payLoad/status envelope (AssetsList in the spec).The
payLoad of an AssetsList response.Deserialization holder for the asset/list response (
AssetsList).Lifecycle status of an installed-base asset.
Thrown by
EquinixAsync convenience methods (such as EquinixAsync.awaitAll(Collection)) when
the calling thread is interrupted while waiting for asynchronous work to complete.Metadata for a file attachment in the Equinix Customer Portal (Attachments v1
attachment).JSON model for an Attachments v1
attachment (GET /v1/attachments/{attachmentId},
GET /v1/attachments, POST /v1/attachments/file).Purpose for which an attachment is uploaded
(
POST /v1/attachments/file, purpose query parameter).Optional query parameters of the Application Connect "attached ..." list endpoints: a state filter
(sent as
state or attachmentStatus, as each endpoint names it), order and
style.Detail level of the response (
Style in the spec; default MEDIUM).Reference to a previously uploaded attachment, identified by its id and name.
Client interface for managing file attachments in the Equinix Customer Portal.
The source of a support case attachment (
Attachment.source).An attribute included on a resource type or action, as returned by the IAM resource-type and
list-actions operations.
Read-only JSON model for an item of the IAM
AttributeSet spec schema.Authentication context of the actor that triggered a cloud event (the Fabric v4
AuthContext schema).The availability assumed for each kind of element, as a fraction (0.9995 = 99.95%).
Composes per-element availability assumptions into a figure per workload, in series and in parallel
over the graph's redundant paths.
Adapter for bridging AWS Direct Connect SDK objects with Equinix Fabric connections.
Configuration for an
AWS_IOT_CORE streaming channel.A
RateCard that sources AWS data-egress rates from the public
AWS Price List Bulk API.Configuration for an
AZURE streaming channel.Adapter for bridging Microsoft Azure ExpressRoute SDK objects with Equinix Fabric connections.
A
RateCard that sources cloud-egress rates from the public
Azure Retail Prices API
(https://prices.azure.com/api/retail/prices).Defines the inter-metro backbone link topology for connecting Cloud Routers
across multiple Equinix metros.
Internal client for Network Edge device Backups.
Client interface for managing device backups on Network Edge.
Bandwidth sizing breakdown for a single connection, showing how the total
bandwidth requirement was derived from individual workload requirements under the
configured
BandwidthStrategy.Deserializes
BandwidthUnit from the varied unit spellings the APIs emit:
canonical values ("MBPS", "Gbps") and short forms ("MB", "gb")
in any case.Determines how the Deployment Wizard sizes bandwidth for provider connections.
An immutable, ascending set of discrete connection sizes in Mbps, as published by the
specification's
Environment.supportedConnectionSizeMbps (and by the Fabric v4 Beta
ProviderEnvironment.supportedBandwidths).Root exception class for all Equinix SDK exceptions.
Standard implementation of
EquinixCredentials using OAuth2 client credentials.A bearer access token supplied by a
BearerTokenProvider: the token value sent as
Authorization: Bearer <value> and, optionally, the instant it expires.Supplies the bearer token that signs every authenticated request, as an alternative to OAuth2
client credentials.
Marks an SDK type that maps a Fabric v4 API family the OpenAPI spec labels Beta.
Creates and caches one
BetaResourceClient per (resource group, model type) pair.Internal resource client for one Fabric Beta response type.
The current user's acceptance of the Digital LOA private beta terms (diLOA v1 API).
A BGP clear/reset action issued against a connection's routing protocol.
Request body for clearing/resetting a routing protocol's BGP session
(
POST /connections/{connectionId}/routingProtocols/{routingProtocolId}/actions).BGP authentication type of an Equinix Internet Access (EIA) v2 routing protocol (spec schema
BgpAuthenticationType).BGP IPv4 or IPv6 connection state operational data (spec schema
BGPConnectionOperation): live session status (UP/DOWN/UNKNOWN)
and the time of the last state change.Values of the
operationalStatus property of the Fabric v4 BGPConnectionOperation schema.Client interface for managing BGP peering sessions on Network Edge devices.
BGP routing protocol nested in a ServiceRequest.A billing account, as returned by the Billing v1 finance accounts API.
Client interface for viewing billing accounts and downloading invoice documents in the Equinix
Customer Portal.
Request body for searching billing accounts (
POST /billing/v2/billingAccounts/search,
searchBillingAccount).Client interface for searching billing accounts via the Platform Billing Account v2 (BAS) API at
/billing/v2/billingAccounts.Status of a billing account as returned by the Platform Billing Account v2 (BAS) API.
A billing account, as returned by the Platform Billing Account v2 (BAS) API.
Billing contact details for a billing account (Billing v1 finance accounts API).
Frequency at which a billing account is billed (Billing v1 finance accounts API).
An invoice available on a billing account (Billing v1 finance accounts API).
A downloadable document attached to an invoice (Billing v1 finance accounts API).
Billing notification: sent when an order is closed and Equinix starts billing (resellers also
receive it for their customers' orders, since R2024.7).
Billing notification body.
One billed line.
A payment recorded against a billing account (Billing v1 finance accounts API).
Billing model of an Equinix Internet Access (EIA) v1 bandwidth configuration.
Quantifies the impact of a hypothetical failure of one customer metro on the customer's
IX peering connectivity.
Cross Connect BMMR Type.
BMMR type of a port (the Fabric v4
Port.bmmrType attribute: SELF,
EQUINIX).Values of the Fabric v4
VirtualConnectionBridgePackageCode schema (the bridge package.code of a virtual connection price access point).The Safe Mutation Broker's two tools -
fabric_propose_change and
fabric_confirm_change - registered through the exact same ToolRegistration
seam as the read-only catalog, in the opt-in Toolset.MUTATE toolset.The expected monthly cost must not exceed
commercial.budgetMaxMonthly.The objectives the Metro Optimizer measures on every portfolio.
Request to create a dual diverse pair of Optical Connect connections.
The SDK's bundled reference exchange rates: the European Central Bank's euro reference rates of
2026-11-11 (retrieved 2026-11-12 from
https://www.ecb.europa.eu/stats/eurofxref/eurofxref-daily.xml),
plus the AED, which the ECB does not publish, derived from its peg of 3.6725 AED per USD.A cabinet in an Equinix IBX data center, as returned by the Equinix Internet Access (EIA) v1
product-availability lookup
GET /internetAccess/v1/cabinets.Internal client for the Equinix Internet Access (EIA) v1 product-availability lookup:
GET /internetAccess/v1/cabinets - the cabinets a customer has, optionally narrowed by
cage, IBX and account.Internal client implementation for the Equinix Internet Access (EIA) v1 product-availability
lookup
GET /internetAccess/v1/cabinets.A single cabinet dimension (
value and unit) on a secure cabinet order
(Dimension schema).A single cabinet dimension (
value and unit) in a secure cabinet product
availability response (Dimension schema).Cabinet dimensions (
width, depth, height) on a secure cabinet order
(Dimensions schema).Cabinet dimensions (
width, depth, height) in a secure cabinet product
availability response (Dimensions schema).Read-only JSON model for a
Cabinet returned by the Equinix Internet Access (EIA) v1
product-availability lookup GET /internetAccess/v1/cabinets.Reference to a cabinet by its space identifier in the Equinix Internet Access (EIA) v1
product-availability lookups.
A cabinet node within an asset hierarchy cage, containing circuits.
Type of a cabinet within a cage (Customer Portal Lookup v2 API).
Typed
serviceDetails for a smart hands request-cables order
(cableRequestRequest.serviceDetails in the smart hands v1 spec).A cage in an Equinix IBX data center, as returned by the Equinix Internet Access (EIA) v1
product-availability lookup
GET /internetAccess/v1/cages.Cage or cabinet type in a Lookup v2 location (
cage_details.type: SHARED,
PRIVATE; cage_details.cabinetType: PRIVATE, DEMARCATION).Typed
serviceDetails for a smart hands cage-cleanup order
(cageCleanupRequest.serviceDetails in the smart hands v1 spec).Internal client for the Equinix Internet Access (EIA) v1 product-availability lookup:
GET /internetAccess/v1/cages - the cages a customer has in a given IBX.Internal client implementation for the Equinix Internet Access (EIA) v1 product-availability
lookup
GET /internetAccess/v1/cages.Details of a cage (and its cabinet) at an IBX location (Customer Portal Lookup v2 API).
Typed
serviceDetails for a smart hands cage-escort order
(cageEscortRequest.serviceDetails in the smart hands v1 spec).Read-only JSON model for a
Cage returned by the Equinix Internet Access (EIA) v1
product-availability lookup GET /internetAccess/v1/cages.Reference to a cage by its space identifier in the Equinix Internet Access (EIA) v1
product-availability lookups.
A cage node within an asset hierarchy, containing cabinets.
Type of a cage at an IBX location (Customer Portal Lookup v2 API).
The cancellation state of one MCP tool call.
Request body for cancelling an order.
Chooses which metros a
Solver considers.Grid carbon intensity per metro, supplied by the caller, with its provenance.
"carbon": the grid carbon intensity of where a portfolio runs its workloads, in
"gCO2e/kWh", from a caller-supplied
CarbonIntensityTable.The
DesignContext of one Metro Optimizer run: the metro catalogue, Fabric's measured
metro-to-metro round trips, cloud reachability per metro and the cost model, held in memory and
never changed after CatalogDesignContext.Builder.build().Assembles a
CatalogDesignContext.A category within an asset-list response, grouping a set of templates.
Current state of the latest change applied to an Equinix Internet Access (EIA) v2 service.
Payload of a
Change: the service the change targets plus the serialized change request,
and (for rejected/failed changes) the rejection reason or error list.Reference to the service a
Change targets.An error entry attached to a
FAILED Change.Additional per-property information (
ErrorAdditionalInfo) attached to a
Change.ChangeError: the reason of the error and the request property that caused it.A single change operation (
ConnectionChangeOperation / NetworkChangeOperation /
CloudRouterChangeOperation in the Fabric v4 spec).Change log
Audit trail of who created, last updated and (optionally) deleted an Equinix Internet Access
(EIA) v2 object, together with the corresponding timestamps.
Values of the
op property of the Fabric v4 change-operation schemas
(CloudRouterChangeOperation, RoutingProtocolChangeOperation,
RouteFiltersChangeOperation, RouteFilterRulesChangeOperation,
RouteAggregationsChangeOperation, RouteAggregationRulesChangeOperation,
NetworkChangeOperation).A single change operation in the
ChangeRequest body of an Equinix Internet Access
(EIA) v2 service update (PATCH /internetAccess/v2/services/{serviceId}).Common change-reference details shared by Fabric change objects: the change resource
href.Current outcome of a change flow (the Fabric v4
Change.status /
PortChange.status attribute).The kind of lifecycle change recorded against a Fabric resource (the
change.type field).Type of change applied to an Equinix Internet Access (EIA) v2 service (spec schema
ChangeType).The mutations the Safe Mutation Broker can carry - deliberately the smallest honest set:
three creates, each backed by a spec-documented Fabric v4 dry run the propose phase
exercises for real.
Channel used to place an order (Orders v2 / Billing v2 APIs).
The single delivery channel of a streaming subscription.
The delivery channel type for a streaming subscription.
The progress of one plan's execution: every step known to exist, by logical key.
Where reconcile keeps its
Checkpoints.A simple, opt-in consecutive-failure circuit breaker for the SDK's request execution path.
The breaker's lifecycle state.
Thrown when the opt-in
CircuitBreaker is open and a request
was rejected without being sent to the API.Phase of an AC power circuit for a secure cabinet.
A circuit node within an asset hierarchy cabinet.
A circuit node mapped at the cage level within an asset hierarchy.
Registers this server in a Claude Desktop
claude_desktop_config.json by merging
into the mcpServers.equinix entry.Values of the
authtype property of the Fabric v4 AuthContext schema
(cloud events).Internal client for Fabric Cloud Events (read-only).
Payload of a cloud event (the Fabric v4
CloudEventData schema).A valid
POST /fabric/v4/cloudevents/search filter, built so that the scope expression
the service requires is always present.Client interface for Equinix Fabric cloud events (
POST /fabric/v4/cloudevents/search,
GET /fabric/v4/cloudevents/{id}) and live events (POST /fabric/v4/liveEvents/search,
the last operational event per subject, used for project-level active alerts).Default
CloudEvents implementation.A cloud or service provider the design must reach over private interconnect, with the traffic that
drives its cost.
Adapter interface for bridging cloud provider SDK objects with Equinix Fabric connection creation.
Enumeration of supported cloud providers for Equinix Fabric interconnection.
A route-table / BGP-session action issued against a Fabric Cloud Router (for example a route
table refresh) and its status.
Internal client for Fabric Cloud Router route-table / BGP-session actions.
Internal client for Fabric Cloud Router actions (route-table / BGP-session updates).
The state of a Fabric Cloud Router route-table action.
The type of route-table / BGP-session action issued against a Fabric Cloud Router.
Current state of the latest Fabric Cloud Router change (the Fabric v4
CloudRouterChange
schema): change type (e.g.A Fabric Cloud Router diagnostic command (ping / traceroute) and its result.
Internal client for Fabric Cloud Router diagnostic commands (ping / traceroute).
Fluent builder for issuing a Fabric Cloud Router diagnostic command (ping / traceroute).
Request payload for a Fabric Cloud Router diagnostic command (ping / traceroute).
Result payload of a Cloud Router diagnostic command (spec schema
CloudRouterCommandResponse, a oneOf of CloudRouterCommandPingResponse and
CloudRouterCommandTracerouteResponse).Spec schema
marketplaceSubscription (writable members: type, uuid).Spec schema
SimplifiedNotification (writable members: type, emails).Spec schema
CloudRouterPostRequestPackage (code enum: LAB/BASIC/STANDARD/ADVANCED/PREMIUM).Internal client for Fabric Cloud Router packages (read-only).
Values of the
type property of the Fabric v4 CloudRouterPackage schema.Minimal Fabric Cloud Router reference (uuid only) for use as an access-point target.
Client interface for managing Equinix Fabric Cloud Routers.
Simplified Fabric Cloud Router reference returned on an access point (spec schema
CloudRouter).Cloud Router
type values in the Fabric v4 catalog (fetched 2026-09-21).How the Deployment Wizard treats a flow between two clouds.
ClusterConfig class.
An Equinix colocation cost primitive that a
RateCard can price - alongside the
interconnection rates (connection / cloud router / egress).The commercial frame the design is priced and judged in.
Exchange rates pinned in the spec: they take precedence over every other rate source (a caller's
converter, the live ECB rates, the bundled table) and are part of the spec's fingerprint, so a run can be
reproduced exactly.
Logo attached to a company profile (the Fabric v4
CompanyLogo schema).Metro reference attached to a company profile (the Fabric v4
CompanyMetro schema).A Fabric company profile (the public, marketplace-facing profile for an organization).
Account block of a company profile (the Fabric v4
CompanyProfileResponse_account
schema): the root organization identifier.Pending or latest change of a company profile (the Fabric v4
CompanyProfileChange
schema).Fluent builder for Fabric company profiles.
Client interface for managing Equinix Fabric company profiles and their service-profile / tag
attachments.
A service profile reference returned when listing the service profiles attached to a company
profile.
Service profile reference attached to a company profile (the Fabric v4
CompanyServiceProfile schema).Response wrapper for
GET /fabric/v4/companyProfiles/{companyProfileId}/serviceProfiles,
which returns a non-paginated { "data": [...] } envelope.Comparison of the current power reading for a datapoint against historical values
(yesterday, last week, last month and last quarter).
A single datetime/value pair within a trending power data series
(
ComparisonData_Trend in the spec).A step recorded in a
Checkpoint: the resource exists (or its create was accepted) under
this uuid.Share of (metro, stated zone) pairs the portfolio satisfies, 0 to 100: a metro satisfies a
ComplianceZone when its region is one the zone allows, and a geoZones entry when the
live catalogue lists the metro in that zone. 100 when the spec states no zone.Regulatory zones a design must stay within, each allowing a set of Equinix regions.
Every metro must be in a region that at least one zone of
constraints.complianceZones allows
(ComplianceZone.getAllowedRegions()): the design stays within the stated zones.How sure the analyser is that an
EstateFinding is right.Connection acceptance data returned by a connection action (spec schema
ConnectionAcceptanceData).The result of a connection action (
POST /fabric/v4/connections/{connectionId}/actions;
spec schema ConnectionAction).JSON model for a connection action response (spec schema
ConnectionAction).The attachment status of a Route Filter or Route Aggregation on a Fabric connection
(or as listed against a Cloud Router).
Assembles a complete Fabric connection body from a
PlannedConnection - both
endpoints, encapsulation, and cloud authorization - so a live dry-run or a real create sends the
whole request the API needs, not the endpoint-less name + bandwidth shell that Fabric rejects with
EQ-3142501 "Null value for aSide access point".Internal client for Fabric Connections.
A connector type supported by a media type in the Equinix Internet Access (EIA) v1
connection-services lookup (
GET /internetAccess/v1/connectionServices).The per-connection authorization a customer must gather before a provider connection can be
provisioned.
A media type supported by a connection service, with its connector types, in the Equinix
Internet Access (EIA) v1 connection-services lookup
(
GET /internetAccess/v1/connectionServices).How a cloud provider sells the connection a design lands on, which decides the provider-side fee.
Classifies the purpose of a planned connection within a deployment plan.
Client interface for managing Equinix Fabric connections.
The connection search filter properties of the Fabric v4
SearchFieldName schema
(spec 4.34.0), for fabric.connections().search(...).The name of the available cross-connect connection service
(
Connection_services in the cross-connects v2 and lookup v2 specs).A connection service available at an IBX, with its supported media types.
A connection service available at an Equinix IBX data center, as returned by the Equinix
Internet Access (EIA) v1 product-availability lookup
GET /internetAccess/v1/connectionServices.Internal client for the Equinix Internet Access (EIA) v1 product-availability lookup:
GET /internetAccess/v1/connectionServices - the connection services available at a
given IBX.Internal client implementation for the Equinix Internet Access (EIA) v1 product-availability
lookup
GET /internetAccess/v1/connectionServices.JSON model for a cross-connect
Connection_services_details element.Read-only JSON model for a
ConnectionService returned by the Equinix Internet Access
(EIA) v1 product-availability lookup GET /internetAccess/v1/connectionServices.Additional key/value information carried on a connection or connection side.
Values of the Fabric v4
ConnectionType schema, plus two constants the schema does not
list (see the table).Service connection type for Equinix Internet Access (EIA).
Request body for the connection validation API (
POST /fabric/v4/connections/validate).Read-only JSON model for the
ConnectionResponse body returned by the connection
validation API (POST /fabric/v4/connections/validate).Connectivity class.
Physical or virtual port that houses a connection (the Fabric v4
ConnectivitySource schema).Port connectivity type (the Fabric v4
Port.connectivitySourceType attribute:
COLO, BMMR, REMOTE).The connectivity source of an Equinix Internet Access (EIA) connection - where the connection
originates from.
Categorizes how a network can be reached at an Equinix metro.
Cross-connect connector type (
connector_types in the cross-connects v2 and lookup v2 specs).FindingCategory.CONSOLIDATE_BEHIND_ROUTER, both directions.A hard limit.
Chooses the built-in constraints a spec needs, and shared helpers.
The outcome of checking one
Constraint against one portfolio.Availability of a contact person (diLOA v1 + Orders v2 APIs).
Availability of a contact attached to an Equinix Internet Access (EIA) v2 service order.
A single string-typed communications detail of a contact: a
type (such as
PHONE, EMAIL or MOBILE) and its value.Means of contact for a Digital LOA contact detail (diLOA v1 API).
Type of a contact detail entry on an Equinix Internet Access (EIA) order contact (spec schema
ContactItemDetails, property type).A contact on a smart hands order.
A contact attached to an Equinix Internet Access (EIA) v2 service order, as returned in the
service order read model.
A contact detail (email/phone/etc.) of a
ContactItem.A contact (
ContactItem) supplied in the order of an Equinix Internet Access (EIA)
v2 service create.A contact detail (email/phone/etc.) of a
ContactItemRequest.Contact preference for the phone number
Availability of the contact preference
Type of a contact attached to an Equinix Internet Access (EIA) v2 service order.
A notification contact on a colocation v2 order / trouble-ticket update
(
ContactRequestRegisteredUser_Update).Contract term length for a secure cabinet order.
A
RateCard that answers every lookup in one target currency: a figure quoted in another currency is
converted through a CurrencyConverter and its note says from what, at which rate, from which source
and as of when.Identifies a correlated failure - multiple connectivity paths that share a
single failure domain and would fail simultaneously.
The modelled monthly and one-time cost of a single
DeploymentArchetype,
broken out into named line items.Whether the cost of every feasible design can be compared in the spec's currency, and what the
optimiser does when it cannot because an exchange rate is missing.
Aggregated cost estimate across all recommended metros.
One priced item of a portfolio, with where the figure came from and how far it could be off.
How a line was restated in the comparison currency.
Prices a portfolio.
Expected monthly total of the portfolio from the run's
CostModel: the same figure the result
reports.Request body for creating an IAM access policy via
POST
/v1/projects/{projectId}/accessPolicies (operationId createAccessPolicy, spec schema
CreateAccessPolicyBody).Create ASN request body
Create Cross Connect request.
Create Loa
Create Loa Note
Request body for registering a new OIDC provider via
POST
/v1/projects/{projectId}/oidcProviders (operationId createOidcProvider, spec schema
CreateOidcProviderBody).Request body for creating an IAM permission set via
POST
/v1/projects/{projectId}/permissionSets (operationId createPermissionSet, spec schema
CreatePermissionSetBody).Request body for creating an IAM policy mask via
POST
/v1/projects/{projectId}/policyMasks (operationId createPolicyMask, spec schema
CreatePolicyMaskBody).Request body for creating an IAM role assignment via
POST /v1/roleAssignments
(operationId createRoleAssignment, spec schema CreateRoleAssignmentInput).Nested object describing the scope of a role assignment — the resource (by
id and
type) within which the assigned role applies, optionally with a parent
reference.Nested object identifying the parent of an assignment scope — when the scope
type
is PORT, the owning project (spec: CreateRoleAssignmentInput →
assignmentScope.parent; both id and type are required, and
type only admits PROJECT).Account the Cross Connect belongs to.
Document the action applies to.
Action Data.
Note supplied by the customer when responding to an action.
Note the action applies to.
Cross Connect Action Request.
Cross Connect Action Response.
Action Data.
Cross Connect Action State.
Action to perform on the Cross Connect.
A-Side demarcation point.
A-Side connection details.
CrossConnectASideRequestDemarcationPoint model.
A-Side connection details.
Cross Connect Attachment.
Document attached to a Cross Connect.
Attachment Source.
Sub-resource type.
List of documents attached to the Cross Connect.
Cross Connect Change Log.
Availability preference.
Cross Connect Contact Preference.
Request body for placing a cross-connect deinstallation order
(
POST /colocations/v2/orders/crossConnects/deinstall, Layer1_Deinstall_request).Cross Connects returned by a diverse order.
Link to a Cross Connect sub-resource.
LOA Reference for Cross Connect.
Cross Connect Location details.
Cross-connect media type (
media_types in the cross-connects v2 spec).Cross Connect Note.
Cross Connect Note.
Party that added the note.
Sub-resource type.
Cross Connect Notification.
Request body for placing a cross-connect order
(
POST /colocations/v2/orders/crossConnects, Layer1_Create).Note that this note is responding to.
Contact phone number.
Phone number type.
Cross Connect Redundancy.
Priority within the redundancy group.
Cross Connect Response.
CrossConnectResponseAllowedActions model.
Client interface for ordering cross-connects in the Equinix Customer Portal.
Fabric v4 cross connects (real physical orders) (12 operations).
Cross Connect schedule window offered at an IBX.
A-Side of the schedule window.
Sub-resource type.
Z-Side of the schedule window.
Schedule of a Cross Connect.
Sub-resource type.
Cross Connect Schedule State.
Service to order alongside the Cross Connect.
Service ordered alongside the Cross Connect.
List of services ordered alongside the Cross Connect.
Service status.
Type of service ordered alongside the Cross Connect.
Implementation of
CrossConnects over the shared FabricBeta apiParams area.Cross Connect State.
Type of Cross Connect.
Request body for updating a cross-connect order
(
PATCH /colocations/v2/orders/crossConnects/{orderId}, Modify_request).Z-Side connection details.
Z-Side demarcation point.
Z-Side connection details.
Z-Side demarcation point.
ISO 4217 currency code of the billing account attached to an Equinix Internet Access (EIA) v1
account (
GET /internetAccess/v1/accounts).Restates an amount in another currency, so a design whose prices come back in several currencies
(the live Fabric price search quotes London in GBP, Frankfurt in EUR, Tokyo in JPY) is priced and
ranked in one.
An amount restated in another currency.
Where a rate came from, in precedence order.
A rate between two currencies.
Builds the currency converter every cost model uses, and reports what it did.
First-answer-wins composition that can report fallbacks.
The single reconciliation rule shared by every design-time cost model
(
TcoEngine, SavingsCalculatorEngine, MetroOptimizerEngine,
DeploymentWizardEngine, and plan value realization).Typed request body for the asset/tagpoint/current POST endpoint (CurrentTagPointRequest).
Customer billing account data attached to an Equinix Internet Access (EIA) v1 price entry.
Customer Autonomous System Number range used by a BGP routing protocol.
The primary entry point for accessing Equinix Customer Portal APIs.
A customer-route allowance on an Equinix Internet Access (EIA) v1 default configuration: an
import policy plus the advertised prefix length.
An allowed customer-route configuration for an Equinix Internet Access (EIA) v1 service, as
returned by
GET /internetAccess/v1/customerRouteConfigurations.Internal client for the Equinix Internet Access (EIA) v1 customer-route-configuration lookup:
GET /internetAccess/v1/customerRouteConfigurations - the allowed customer-route
configurations for a given use case, redundancy and routing-protocol type.Internal client implementation for the Equinix Internet Access (EIA) v1
customer-route-configuration lookup
GET /internetAccess/v1/customerRouteConfigurations.Read-only JSON model for a
CustomerRouteConfiguration returned by the Equinix Internet
Access (EIA) v1 lookup GET /internetAccess/v1/customerRouteConfigurations.Customer-route allowance of an Equinix Internet Access (EIA) v1 customer-route configuration.
Per-IP-version (IPv4 / IPv6) allowances of an Equinix Internet Access (EIA) v1 customer-route
configuration.
Customer route of IP Version 4 (IPv4) nested in an IPv4 routing protocol request.
Customer route of IP Version 6 (IPv6) nested in an IPv6 routing protocol request.
Peering allowance of an Equinix Internet Access (EIA) v1 customer-route configuration.
Routing-protocol allowances of an Equinix Internet Access (EIA) v1 customer-route configuration.
A
RateCard whose prices are supplied by the caller - e.g. negotiated
contract rates - instead of published list pricing or built-in heuristics.Fluent builder for a
CustomRateCard.CvpType class.
Unit of data volume for egress inputs.
A single reading within a trending environment data series.
What changed between two
DesignDecisionRecords, for example the same design re-run a quarter later:
the spec, the recommendation and its objective values, the cost, the resilience verdicts and the findings.Connection A-side access point of an Equinix Internet Access (EIA) v1 dedicated-bandwidth
configuration.
Connection A-side of an Equinix Internet Access (EIA) v1 dedicated-bandwidth configuration.
An allowed dedicated-bandwidth configuration for an Equinix Internet Access (EIA) v1 service, as
returned by
GET /internetAccess/v1/dedicatedBandwidthConfigurations.Internal client for the Equinix Internet Access (EIA) v1 dedicated-bandwidth-configuration lookup:
GET /internetAccess/v1/dedicatedBandwidthConfigurations - the allowed dedicated-bandwidth
configurations for a given use case, billing model and physical-port speed.Internal client implementation for the Equinix Internet Access (EIA) v1
dedicated-bandwidth-configuration lookup
GET /internetAccess/v1/dedicatedBandwidthConfigurations.Read-only JSON model for a
DedicatedBandwidthConfiguration returned by the Equinix
Internet Access (EIA) v1 lookup GET /internetAccess/v1/dedicatedBandwidthConfigurations.Connection allowance of an Equinix Internet Access (EIA) v1 dedicated-bandwidth configuration.
Physical-port speed allowance of an Equinix Internet Access (EIA) v1 dedicated-bandwidth
configuration.
Port allowance of an Equinix Internet Access (EIA) v1 dedicated-bandwidth configuration.
Connection A-side access point of an Equinix Internet Access (EIA) v1 dedicated-port default
configuration.
Connection A-side of an Equinix Internet Access (EIA) v1 dedicated-port default configuration.
Connection allowance of an Equinix Internet Access (EIA) v1 dedicated-port default configuration.
Customer-route allowance of an Equinix Internet Access (EIA) v1 dedicated-port default
configuration.
A default dedicated-port configuration for an Equinix Internet Access (EIA) v1 service, as
returned by
GET /internetAccess/v1/dedicatedPortDefaultConfigurations.Internal client for the Equinix Internet Access (EIA) v1 dedicated-port default-configuration
lookup:
GET /internetAccess/v1/dedicatedPortDefaultConfigurations - the default
dedicated-port configurations for a given IBX.Internal client implementation for the Equinix Internet Access (EIA) v1 dedicated-port
default-configuration lookup
GET /internetAccess/v1/dedicatedPortDefaultConfigurations.Read-only JSON model for a
DedicatedPortDefaultConfiguration returned by the Equinix
Internet Access (EIA) v1 lookup GET /internetAccess/v1/dedicatedPortDefaultConfigurations.Physical-port details of an Equinix Internet Access (EIA) v1 dedicated-port default configuration.
Port allowance of an Equinix Internet Access (EIA) v1 dedicated-port default configuration.
Routing-protocol allowances of an Equinix Internet Access (EIA) v1 dedicated-port default
configuration.
Per-IP-version (IPv4 / IPv6) routing allowances of an Equinix Internet Access (EIA) v1
dedicated-port default configuration.
The rules an analysis runs when the caller supplies none.
Cross Connect Deinstallation Schedule.
Schedule code of the removal.
Schedule type.
A Fabric resource model whose
delete(...) can be called on the model itself.Demarcation point details of a physical port in an Equinix Internet Access (EIA) v1 product
configuration.
The deployment approaches the TCO model compares.
The result of executing a deployment plan.
A deployment plan produced by the Deployment Wizard: the Cloud Routers, provider connections,
backbone links and routing protocols to create, the native multicloud links and Fabric
Interconnects the design relies on but the SDK does not create, pricing, and the layered
validation state.
The recommended deployment topology: which workloads are placed in which metros.
Entry point for the Deployment Wizard.
Fluent builder for configuring a deployment plan.
A root-level entry point that gathers the SDK's value-add design capabilities -
Metro Optimizer, Deployment Wizard, Peering Intelligence, Savings Calculator, and TCO
comparison - in one discoverable place, alongside the API-domain clients (
Fabric,
NetworkEdge, ...).Hard limits: a design that breaks one is not offered, whatever its score.
The read-only facts of one design run.
A Design Decision Record: what was decided for a
DesignSpec, why, on what evidence, and what would
change the decision.One option on the frontier.
The options considered and rejected.
One assumption.
One workload's estimated availability, under planning assumptions.
What one constraint did to the search.
The requirements, restated from the spec in words.
What the recommended design costs, and where each figure came from.
One priced line.
The recommended design.
An exchange rate a line was converted at.
The design priced month by month under the spec's growth, with a term recommendation per item.
One item's growth and term decision.
How to build and reproduce the design.
The frontier option nearest the recommendation.
One objective of the recommended design.
A deployment plan in brief.
What the record rests on.
What pins the record's figures.
The failure simulation of the recommended design.
One finding.
Finding severity, most severe first.
Every finding, de-duplicated, most severe first.
Egress savings of the private path.
How firm the decision is.
The TCO archetype comparison.
The TCO and egress-savings view of the design's main cloud.
An N-1 or N-2 verdict.
The share of one objective's weight over which the recommendation holds.
Produces a
DesignDecisionRecord: runs the engines for a spec (Metro Optimizer, then resilience analysis,
then the growth and value models where the spec gives enough input, then a deployment plan) and records their
results section by section.An explicit, immutable graph of one design: sites, metros, Cloud Routers, cloud on-ramps, clouds,
workloads and (optionally) peer networks, joined by access circuits, the inter-metro backbone,
primary and standby cloud connections, provider links and workload hosting, each with its capacity
and round-trip latency where known.
Builds the
DesignGraph of a spec on a portfolio.What "better" means for this design: a weight per objective id.
One feasible design with everything measured about it.
A bundle of extra objectives and constraints contributed by a library on the classpath.
What a
Solver found.One design, stated as intent.
Reads and writes a
DesignSpec as JSON or YAML.The design tools' single in-memory store: deployment plans keyed by their
plan_id and
optimization results keyed by the fingerprint of the spec they were run for, so the tools can be
chained (design_optimize then design_plan_deployment, design_get_plan,
design_plan_drift, design_export_terraform) without repeating work.A stored entry.
What a store entry holds.
The outcome of a lookup.
The outcome of a store.
How a lookup resolved.
How a stream alert rule detects an alert condition (the Fabric v4
DetectionMethodResponse schema): a THRESHOLD or OUTLIER check
over a metric window, with warning/critical thresholds and an ABOVE/BELOW operand.Values of the
operand property of the Fabric v4 DetectionMethod schema (stream alert rules).Values of the
type property of the Fabric v4 DetectionMethod schema (stream alert rules).A Network Edge virtual device.
The ACL templates associated with a virtual device, returned by the device-level ACL
read operation.
Details of an ACL template as applied to a virtual device, including its current
provisioning
DeviceACLStatus on the device.Request body for associating ACL templates with a virtual device.
The provisioning status of an ACL template on a virtual device.
Options for
DELETE /ne/v1/devices/{uuid}: the deleteRedundantDevice query
parameter and the optional deletionInfo body (VirtualDeviceDeleteRequest).SecondaryDeviceDeleteRequest.Virtual device details as returned by the Network Edge API
(
VirtualDeviceDetailsResponse in the network-edge v1 catalog spec).Client interface for managing device link groups on Network Edge.
License options keyed by license type.
Device management type (network-edgev1 wire values
EQUINIX-CONFIGURED /
SELF-CONFIGURED - hyphenated, unlike the constant names).DevicePricingDetail class.
DeviceReboot class.
DeviceRebootHistory class.
Request body for triggering an RMA (Return Merchandise Authorization) of a virtual device.
The user public key details supplied with an RMA request.
Client interface for managing Network Edge virtual devices.
DeviceUpgrade class.
DeviceUpgradeHistory class.
A Digital Letter of Authorization (Digital LOA) document from the Equinix Customer Portal
diLOA v1 API.
A change record applied to a Digital LOA document, from the Equinix Customer Portal diLOA v1 API.
Request body for creating a Digital Letter of Authorization (Digital LOA) document.
Client interface for managing Digital Letters of Authorization (Digital LOAs) in the Equinix
Customer Portal.
Search criteria body for
POST /diloa/v1/digitalLoas/search (LoaSearch):
{"filter":{"and":[criterion | {"or":[criterion, ...]}, ...]}}.Builder for
DigitalLoaSearchRequest.One search criterion (
LoaCriterion): a property, an operator
(=, IN, LIKE, CONTAINS) and one or more values.The
filter object (LoaSearchItem).An
{"or":[...]} group (Expression).Envelope for the Digital LOA search endpoint, wrapping the
data list of Digital LOA
documents.Unit of measure for a cabinet dimension value.
Whether a smaller or a larger
Objective value is better.IP Version 4 (IPv4) peering nested in a direct routing protocol request.
IP Version 6 (IPv6) peering nested in a direct routing protocol request.
IP Version 4 (IPv4) routing protocol request for the
DIRECT routing protocol, carrying
customer routes plus the collection of direct peerings.IP Version 6 (IPv6) routing protocol request for the
DIRECT routing protocol, carrying
customer routes plus the collection of direct peerings.DIRECT routing protocol nested in a ServiceRequest.Internal client for the STS unauthenticated discovery endpoints:
GET /jwks (operationId getJwks) and
GET /.well-known/openid-configuration (operationId getOpenIdConfiguration).Internal client implementation for the STS unauthenticated discovery endpoints.
Request to create several Cross Connects in a single order.
Rates the geographic diversity of failover paths for resiliency analysis.
Geographic diversity assessment between a primary and backup metro.
DownloadableImage class.
DowntimeNotification class.
Compares a plan with a
LiveState snapshot.How a planned resource compares with what is live.
What a
GraphEdge of a DesignGraph stands for.Whether a redundant edge is the one used in normal operation or the one held for failover.
Internal client for the IAM effective-permissions resolution:
GET /v1/projects/{projectId}/effectivePermissions (operationId
getEffectivePermissions).Internal client implementation for the IAM effective-permissions resolution.
The effective (resolved) permissions for a principal within a project and service, as
returned by the IAM effective-permissions operation.
A single effective-permission entry: the caller may perform any of the
EffectivePermissions.Permission.getActions()
on the referenced resources (or any except those referenced), optionally gated by a
Cedar EffectivePermissions.Permission.getCondition() expression.An
anyOf selector that is either an inclusion set (the listed values) or an exclusion
set ({except: [...]}).Read-only JSON model for the IAM
EffectivePermissions response.Read-only JSON model for the
anyOf resource selector, which is either a bare array of
values (inclusion) or an object {except: [...]} (exclusion).The network path data egress takes when leaving a cloud provider.
A usage-based data-egress price expressed per gigabyte, tagged with its
PriceSource.Values of the Fabric v4
InternetAccessBgpAuthType schema (spec 4.34.0): whether a BGP
authentication key is configured on an EIA routing protocol.Billing variant of an Equinix Internet Access (EIA) service.
The routing protocol of an EIA service as read back (spec
InternetAccessRoutingProtocol
and its BGP variant InternetAccessRoutingProtocolBgp, 4.34.0).Reference to an ASN resource:
{"href": ..., "uuid": ...}.Routing protocol configuration for an Equinix Internet Access (EIA) service create request.
ASN resource reference:
{"uuid": ...}.Routing protocol type configured on an Equinix Internet Access (EIA) service.
An Equinix Internet Access (EIA) service, providing dedicated internet connectivity
(single or dual) over Equinix Fabric.
Billing account associated with an Equinix Internet Access (EIA) service.
Billing configuration of an Equinix Internet Access (EIA) service.
Reference to the change object of an Equinix Internet Access (EIA) service.
Request body for creating an Equinix Internet Access (EIA) service, modelling the spec's
InternetAccessPostRequest.A metro location associated with an Equinix Internet Access (EIA) service.
Order details of an Equinix Internet Access (EIA) service.
Client interface for managing Equinix Internet Access (EIA) services.
Current lifecycle state of an Equinix Internet Access (EIA) service.
Type of an Equinix Internet Access (EIA) service: either single or dual internet access.
Use case for an Equinix Internet Access (EIA) service.
The kinds of element an availability is assumed for (see
AvailabilityAssumptions).Full details of a single email associated with a support case, as returned by the support v1
email details endpoint (
EmailDetailsResponse).Full details of an email associated with a support case (
EmailDetailsResponse), returned
by GET /support/v1/tickets/emailDetails/{emailId}/caseNumber/{caseNumber}.One message received in peek-lock mode, together with its settlement operations.
The header attributes common to every EMG notification: the
Task attributes other than
Body, plus the envelope's Signature.Pulls messages from an
EmgReceiver, parses them with EmgMessageParser, dispatches
them to an EmgMessageHandler and settles each one explicitly:
complete when the handler returns normally;
abandon when the handler throws (the broker redelivers it; after the queue's max
delivery count Service Bus dead-letters it itself);
dead-letter with reason "EmgUnparseableMessage" when the body is not an EMG
envelope (redelivery could never succeed).
A parsed Equinix Messaging Gateway notification.
Callback interface for typed EMG notifications.
Parses Equinix Messaging Gateway message bodies into typed
EmgMessages.Thrown by
EmgMessageParser when input is not an EMG envelope at all: empty, not JSON,
not a JSON object, or without a Task object.A peek-lock receiver bound to one EMG queue (or topic subscription).
The action an EMG notification reports (
Task.Verb).Port encapsulation (the Fabric v4
PortEncapsulation.type /
ServiceProfileLinkProtocolConfig.encapsulation enums: QINQ,
DOT1Q, UNTAGGED).End customer details for a connection.
A streaming environmental reading (such as temperature or humidity) for an IBX asset,
including the measured value, unit and the tag it was sampled from.
Request body of the Fabric v4
EnvironmentActionRequest schema, sent to
POST /fabric/v4/serviceProfiles/{serviceProfileId}/environments/{environmentId}/actions.The Fabric v4
EnvironmentActionResponse schema: the 201 body of
POST /fabric/v4/serviceProfiles/{serviceProfileId}/environments/{environmentId}/actions.Wire model of the Fabric v4
EnvironmentActionResponse schema.Values of the Fabric v4
EnvironmentActionStateEnum schema: the state property of
EnvironmentActionResponse.Values of the Fabric v4
EnvironmentActionTypeEnum schema: the type property of
EnvironmentActionRequest and EnvironmentActionResponse.An
environmental message-type entry within a subscription's MessageType.Client interface for accessing IBX SmartView environmental sensor data.
Identifies the asset associated with an
Environment reading, including its
level within the facility.Current environmental (temperature and humidity) data for a single hierarchy node,
wrapped in the
payLoad/status envelope returned by the legacy
/environment/v1/current endpoint.The
payLoad of an EnvironmentData response.A single environmental data entry within the
payLoad.data array returned by the
legacy /environment/v1/listCurrent endpoint.Deserialization holder for the legacy
/environment/v1/listCurrent response,
which wraps a totalCount and data array inside a payLoad
envelope alongside the status object.The streaming envelope wrapping an
Environment payload, carrying the message
type and its data.A specification environment seen from the customer side: the pair of provider sites a
connection joins, the environment id both providers agreed on, the connection sizes the
environment supports and its visibility (
environment.yaml#/Environment).Identifies the monitoring tag associated with an
Environment reading.A measured value paired with its unit, as reported by an
Environment reading.Visibility of a specification environment in a provider's customer-facing APIs
(
environment.yaml#/EnvironmentVisibility); carried by
Environment.environmentVisibility, output only.A single Equinix session that owns one authenticated core client - a single
OAuth token and a single HTTP connection pool - and vends every domain client over it.
A small, generic asynchronous facade over any Equinix SDK call, backed by Java 21
virtual threads.
Thrown when the Equinix API returns HTTP 401 Unauthorized.
Thrown when the Equinix API returns HTTP 403 Forbidden.
Low-level transport client: owns the token lifecycle, the pooled HTTP client, the resolved
endpoint, and the merged apiParams catalogue, and signs and dispatches every request.
The base class for all Equinix SDK domain entry points.
Thrown for client-side errors such as request building failures, serialization errors,
or network connectivity issues.
Construction-time options for an Equinix client or
Equinix session, passed instead of the
bare (credentials, sandbox) arguments when finer control is needed:Thrown when the Equinix API returns HTTP 409 Conflict.
Represents credentials for authenticating with the Equinix Platform APIs.
Supplies the
EquinixCredentials used to obtain an OAuth2 access token.The SDK's pooled, timeout-bounded HTTP client.
Bridges PeeringDB Equinix IX and facility IDs to Equinix Fabric
MetroId values entirely
from live data - no hardcoded city table.The embedded Equinix Intelligence MCP Server - a community server, not affiliated
with Equinix and separate from Equinix's official Fabric MCP server (Public Preview at
https://mcp.equinix.com/fabric).Builder for
EquinixMcpServer.Launches the embedded Equinix Intelligence MCP Server over stdio - the entry point an MCP
host (Claude Desktop, Cursor, VS Code, ...) configures as a command.
Thrown when the Equinix API returns HTTP 404 Not Found.
A
RateCard backed by the live Equinix Fabric Pricing API
(fabric.prices()); the authoritative source of Equinix-side connection
and Cloud Router prices for the cost, savings, and TCO models.Thrown when the Equinix API returns HTTP 429 Too Many Requests.
Base request type for all Equinix API calls.
Immutable view of a single HTTP exchange, exposing exactly what response handling needs: the
status line, a read-only case-insensitive snapshot of the response headers, and the body stream
with its declared length.
Thrown when the Equinix API returns an HTTP 5xx server error (500, 502, 503, 504).
Thrown when the Equinix API returns an error HTTP response.
The default
EquinixCredentialsProvider: holds a single, fixed EquinixCredentials
instance supplied at construction and returns it on every EquinixCredentialsProvider.getCredentials() call.Typed
serviceDetails for a smart hands equipment-install order
(equipmentInstallRequest.serviceDetails in the smart hands v1 spec).An error reported inline on a resource (the Fabric v4
Error schema), e.g. in
ConnectionOperation.errors or IpBlock.error.Additional per-property detail on an
Error (the Fabric v4
PriceError_additionalInfo schema).Analyses what a customer already runs on Equinix and produces a priced, evidence-backed
improvement report.
Configures and runs an analysis.
Reads a scoped estate snapshot from the live APIs.
One evidence-backed improvement to an existing estate.
A figure that supports a finding.
A resource a finding is about.
An immutable, serializable snapshot of the part of an Equinix estate an analysis covers.
Builds an inventory by hand.
How the snapshot was collected.
A Fabric virtual connection.
Something the collector could not read, recorded instead of failing the run.
A Network Edge virtual device.
One side of a virtual connection.
A Fabric network (EVPLAN, EPLAN, IPWAN...).
A Fabric port.
A Fabric Cloud Router.
A Fabric service token.
Collection figures for one resource type.
Prices existing resources through a
RateCard and turns each quote into a CostLine
with a range that reflects its provenance: live Equinix, contract (CUSTOM) and provider-API
prices are exact; reference prices get ± EstateThresholds.referencePriceRangePercent();
estimates get ± EstateThresholds.estimatePriceRangePercent().The result of a price lookup: a cost line, or the reason there is none.
The result of an estate analysis: findings in priority order, totals, the addressable saving per
currency, coverage gaps, and what was not analysed.
One entry of the prioritised action list.
Totals for one category.
An addressable saving in one currency.
A finding whose financial effect could not be priced.
What utilisation data the analysis had.
One analysis rule: a small, pure function from an estate snapshot (and optional utilisation) to
findings.
Which part of an Equinix estate an analysis reads.
The tunable thresholds the default rules use.
Builds thresholds, starting from the defaults.
Every metro of a design must carry a workload (primary or standby) or a cloud connection.
A property-level error annotation nested inside an
ExceptionDetail (the Fabric / Network
Edge additionalInfo[{property, reason}] entries).One structured error entry parsed from an Equinix API error response body, normalised across the
error formats the different Equinix services use (see
ResponseErrorMapper for the formats and
how each maps onto these fields).Internet Exchange Service Action Request
ExchangeServiceActionRequestType values.
ExchangeServiceActionResponse model.
State
ExchangeServiceActionResponseType values.
Additional information regarding the specified Exchange Service
ExchangeServiceCreateRequest model.
Internet Exchange Service type
ExchangeServiceNotification model.
Internet Exchange Service Notification Type
Ordering and billing reference details for this Exchange Service.
ExchangeServiceRequestBgp model.
ExchangeServiceResponse model.
ExchangeServiceResponseBgp model.
State
Internet Exchange Service Type
Internet Exchange (IX) services (5 operations).
Implementation of
ExchangeServices over the shared FabricBeta apiParams area.No metro in
constraints.excludedMetros may be used.No metro may be in a region of
constraints.excludedRegions.The customer-supplied, per-connection authorization a
DeploymentPlan.execute(ExecutionInputs)
run needs to provision cloud provider connections: the cloud-specific authentication key, the DOT1Q
VLAN tag, and (for Azure ExpressRoute) the peering type.How a plan is executed or reconciled.
Examines every portfolio in the allowed size range and returns the exact trade-off frontier.
Denotes which routes should be advertised to the internet for a BGP routing protocol.
The primary entry point for accessing the Equinix Fabric APIs.
Hub for the Fabric v4 operation families the spec marks Beta: one typed client per family.
Default
FabricBeta hub: lazily creates one client per family over a shared
BetaClientFactory.Builds a
CatalogDesignContext from live Fabric data, read-only, once per run: every page of
GET /fabric/v4/metros (coordinates, region, country, geo scopes and zones, measured
connectedMetros.avgLatency) and, when the spec names clouds, every page of the service
profile search (which metros each cloud is reachable from).Narrow capability view of
Fabric that the value-add design engines depend on -
the metro/service-profile/cloud-router/connection/routing-protocol resources the optimizer,
deployment wizard, and peering intelligence actually use.Registers Fabric-specific Jackson (de)serializers on the shared SDK
ObjectMapper
via the JacksonModuleProvider SPI, so core does not depend on Fabric types.Equinix Fabric port or virtual-connection operational-status notification (port/VC up or down),
delivered with
Task.Resource DataCenter.Network.Port or
DataCenter.Network.VirtualConnection.Fabric asset type.
Fabric notification body.
Virtual connections on a port.
The affected port or virtual connection.
Embedded related resources.
Operational-status details.
Operational status of the port or connection.
Fabric notification type.
Fabric port speed available for a secure cabinet location.
"geo_zones_failover": data sovereignty that holds through failover.
An alternative connectivity path for reaching a target ASN from a different
Equinix metro than the primary location.
What execution does when a create step fails: a Cloud Router, connection or routing-protocol
create that is rejected, a pre-flight dry-run that is rejected (HTTP 4xx validation), or a
resource that lands in a terminal failure state or does not reach
PROVISIONED within the
timeout.One failure to simulate: the graph nodes and edges it takes away.
Defines the scope of a hypothetical failure scenario for blast radius analysis.
Simulates failure scenarios on one
DesignGraph.One field that differs between the plan and the live resource.
A
CheckpointStore that keeps one JSON file per deployment in a directory
(<deployment>.checkpoint.json, the name reduced to file-safe characters).Indicates whether an uploaded file is a license file (
LICENSE) or a
cloud-init / bootstrap file (CLOUD_INIT).File type of a generated report (Reports v1
downloadable-report.fileType).Generic request body for paginated, filtered POST search endpoints (filter only, no sort).
Generic request body for paginated, filtered, sorted POST search endpoints.
The money a finding's recommended action would save (positive) or cost (negative), with where the
figures came from and how far they could be off.
The kind of impact.
What kind of improvement an
EstateFinding proposes.Live ECB reference rates from the Frankfurter API (no key): one
GET <baseUrl>/latest?base=<target>
per converter, made on the first conversion that needs it and cached for the converter's life; never
retried.Fetches a URL's body; injectable so tests never reach the internet.
Router package as read back (spec
CloudRouterPackage, 4.34.0).A
RateCard that sources Google Cloud data-egress rates from the
Cloud Billing Catalog API
(https://cloudbilling.googleapis.com/v1/services/{service}/skus).Geographic coordinates of an Equinix IBX data center.
Geographic boundary type for a connection's geo scope.
Geographic zone of a Fabric metro (fabricv4
GeoZone) - e.g.Data sovereignty: every metro must belong to at least one of
constraints.geoZones according
to the live catalogue's geoScopes/geoZones for that metro (matched case-insensitively;
CH, AU, BR, JP, CA, US also match the corresponding
geo scope).Adapter for bridging Google Cloud Interconnect SDK objects with Equinix Fabric connections.
A paginated list of the access policy ids granted to a subject within a project (spec schema
ListAccessPoliciesGrantedOutput), as returned by POST /v1/accessPoliciesGranted
(operationId listAccessPoliciesGranted).The OAuth2 grant types accepted by the Equinix token endpoint
(
POST /oauth2/v1/token).One edge of a
DesignGraph.One node of a
DesignGraph.A design priced month by month under traffic growth, with a commitment-term recommendation per item.
One item's projection and term decision.
One commitment term for one item.
Growth and commitment-term decisions for one design: projects traffic month by month from
commercial.annualGrowthRate over commercial.horizonMonths, finds the Fabric bandwidth tier
each connection needs each month, prices the design month by month, recommends a commitment term per
item, and produces a scenario band.Seeded Monte Carlo settings.
Health of the Fabric API (the Fabric v4
HealthResponse schema).Client interface for retrieving IBX SmartView hierarchy structures.
Level of a node in the SmartView location hierarchy (spec schema
HierarchyNode, property
levelType).A node in the recursive location hierarchy tree returned by
/smartview/v1/hierarchy/location.The affected-customer-assets hierarchy (cage > cabinet > circuit) returned by the
asset/tagpoint/affected-assets endpoint, wrapped in the
payLoad/status
envelope (HierarchyNodeForAssetAPI in the spec).The
payLoad of a HierarchyNodeForAssetAPI response.Deserialization holder for the affected-assets response (
HierarchyNodeForAssetAPI).A single hop of a Cloud Router traceroute command (spec schema
Hop).A single probe within a traceroute hop (spec schema
Hop_probes).A
DELETE request that can carry a request body.The result of asking the person at the MCP client to approve one action through a form
elicitation (
ServerContext.confirmWithHuman(String), delivered by a HumanConfirmer).What the client reported for one confirmation prompt.
How the server asks the person at the MCP client to approve one action.
FindingCategory.HYGIENE: one finding per issue and resource kind, listing every affected
resource (so an estate with 80 stuck connections gets one finding, not 80).The primary entry point for accessing the Equinix Identity and Access Management (IAM) API
(Access v1) - Equinix's attribute-based access control (ABAC) and role-based access control
(RBAC) plane.
Client interface for project-scoped IAM access policies and their grants
(
/v1/projects/{projectId}/accessPolicies).Client interface for resolving IAM effective (computed) permissions.
Client interface for project-scoped IAM permission sets
(
/v1/projects/{projectId}/permissionSets).Client interface for project-scoped IAM policy masks
(
/v1/projects/{projectId}/policyMasks).Client interface for project-scoped IAM principal policies
(
/v1/projects/{projectId}/principalPolicies).Client interface for discovering the IAM access model: resource types, actions, action sets,
resource-type-to-action mappings, and per-service policy schemas.
Client interface for IAM role assignments - associating a principal with a role within a scope.
Client interface for the IAM roles catalog.
An Equinix IBX data center where Equinix Internet Access (EIA) is available, as returned by
the product-availability lookup
GET /internetAccess/v2/ibxs.Internal client for the Equinix Internet Access (EIA) v2 product-availability lookup:
GET /internetAccess/v2/ibxs - the IBXs where EIA is available for a given service
connection type.Internal client implementation for the Equinix Internet Access (EIA) v2 product-availability
lookup
GET /internetAccess/v2/ibxs.IBX detail for the order history locations endpoint
(
ibx-detail-for-locations-endpoint): the IBX code and its metro,
region, country, city, state, address and
postalCode.Read-only JSON model for an
Ibx returned by the Equinix Internet Access (EIA)
product-availability lookups — the v2 list (GET /internetAccess/v2/ibxs) and the v1
single-IBX get (GET /internetAccess/v1/ibxs/{ibx}).IBX, cage, account and cabinet location for a smart hands order.
An IBX location reference holding only the IBX code, as used throughout the Equinix Internet
Access (EIA) v1 lookups (terms, colocation spaces, price entries, port/dedicated-port
configurations, and connection-service connector types).
IBX (data center) maintenance, incident, security-incident or advisory notification:
Task.Resource DataCenter.Maintenance, DataCenter.Incident,
DataCenter.SecurityIncident or DataCenter.Advisory, schema version 1.0 or 2.0.The primary entry point for accessing Equinix IBX SmartView APIs.
Internal client for the Equinix Internet Access (EIA) v1 single-IBX get:
GET /internetAccess/v1/ibxs/{ibx} - the detail for a single IBX data center where EIA
is available.Internal client implementation for the Equinix Internet Access (EIA) v1 single-IBX get
GET /internetAccess/v1/ibxs/{ibx}.FindingCategory.IDLE_OR_UNUSED: resources that are held but not used.ImageDownload class.
ImpactedService class.
Customer-route import policy of an Equinix Internet Access (EIA) v1 routing configuration.
Details for creating an inbound shipment (
InboundShipments_create in the shipments v2
spec).Request body for submitting an inbound shipment order
(
POST /v1/orders/shipment/inbound, inboundShipmentRequest in the shipments v1
spec).Service details for an inbound v1 shipment order (
inboundServiceDetail in the
shipments v1 spec).Details of the inbound shipment itself (
inboundServiceDetail.shipmentDetails).Details for updating an inbound shipment (
InboundShipmentsUpdate in the shipments v2
spec).A
CheckpointStore held in memory: survives an aborted run, not a crashed JVM.Location of an installed patch panel (Customer Portal Lookup v2 API).
The Fabric Interconnect an
IC access point belongs to: {"name": ..., "uuid": ...}.InterfaceDetail class.
InterfaceStats class.
The primary entry point for accessing the Equinix Internet Access (EIA) v2 API.
Client interface for the Equinix Internet Access (EIA) v1 account lookups - the billing accounts
available at an IBX (
GET /internetAccess/v1/accounts), a single account by number
(GET /internetAccess/v1/accounts/{accountNumber}) and an account's agreements
(GET /internetAccess/v1/accounts/{accountNumber}/agreements).Client interface for the Equinix Internet Access (EIA) v1 product-availability lookup
(
GET /internetAccess/v1/cabinets) - the cabinets a customer has, optionally narrowed by
cage, IBX and account.Client interface for the Equinix Internet Access (EIA) v1 product-availability lookup
(
GET /internetAccess/v1/cages) - the cages a customer has in a given IBX.Client interface for the Equinix Internet Access (EIA) v1 product-availability lookup
(
GET /internetAccess/v1/connectionServices) - the connection services available at a
given IBX.Client interface for the Equinix Internet Access (EIA) v2 product-availability lookup
(
GET /internetAccess/v2/ibxs) - the IBX data centers where Equinix Internet Access is
available for a given service connection type.Client interface for the Equinix Internet Access (EIA) v1 operational-units lookup
(
GET /internetAccess/v1/operationalUnits) - the Equinix operational units serving a given
IBX.Client interface for the Equinix Internet Access (EIA) v1 order single get
(
GET /internetAccess/v1/orders/{orderUUID}).Client interface for the Equinix Internet Access (EIA) v1 product-availability lookup
(
GET /internetAccess/v1/patchPanels) - the patch panels a customer has in a given cage
and cabinet.Client interface for the Equinix Internet Access (EIA) v1 price search
(
POST /internetAccess/v1/prices/search).Client interface for the Equinix Internet Access (EIA) v1 product / attribute configuration
lookups - the read-only endpoints under
/internetAccess/v1 that return the allowed and
default configuration values (routing, bandwidth, connection, port) for ordering an EIA service.Client interface for the Equinix Internet Access (EIA) v1 purchase-order lookups - the list
(
GET /internetAccess/v1/accounts/{accountNumber}/purchaseOrders) and the single get
(GET /internetAccess/v1/accounts/{accountNumber}/purchaseOrders/{number}).An Equinix Internet Access (EIA) v2 service, as returned by the create
(
POST /internetAccess/v2/services), get-details
(GET /internetAccess/v2/services/{serviceId}), update
(PATCH /internetAccess/v2/services/{serviceId}) and search
(POST /internetAccess/v2/services/search) operations.Internal client for the Equinix Internet Access (EIA) v2 service lifecycle:
POST /internetAccess/v2/services (create),
GET /internetAccess/v2/services/{serviceId} (get details),
PATCH /internetAccess/v2/services/{serviceId} (update),
DELETE /internetAccess/v2/services/{serviceId} (delete) and
POST /internetAccess/v2/services/search (search).Internal client implementation for the Equinix Internet Access (EIA) v2 service lifecycle.
Read-only JSON model for the
ServiceReadModel / ServiceCreateResponse returned by
the Equinix Internet Access (EIA) v2 service create, get-details, update and search operations.Fluent builder for the nested
ServiceRequest body of an Equinix Internet Access
(EIA) v2 service create.Client interface for the Equinix Internet Access (EIA) v2 service lifecycle.
Client interface for the Equinix Internet Access (EIA) v1 signature-policies lookup
(
GET /internetAccess/v1/signaturePolicies) - the signature policies governing order
acceptance.Client interface for the Equinix Internet Access (EIA) v1 terms-and-conditions lookup
(
GET /internetAccess/v1/terms) - the terms and conditions applicable to an account at a
given IBX for a given product.File type of an invoice document (Billing v1 finance accounts API).
Format in which an account's invoices are produced (Billing v1 finance accounts API).
Client interface for accessing invoice data in the Equinix Customer Portal.
Type of an invoice document (Billing v1 finance accounts API).
An immutable, typed IP address value, optionally with a CIDR subnet prefix length.
An IP block (BYOIP / Equinix-owned IPv4 or IPv6 prefix) managed through Fabric.
Account association for an IP block (carries the Equinix account number).
A single addressing plan entry within an IP block's regulatory information, describing the
intended purpose and size of a portion of the requested address space.
Addressing plan (
IpBlockAddressingPlans) attached to an IP block request when requesting
public IP space for an Equinix Internet Access (EIA) v2 service.Answer to a RIR justification question for a provider-assigned IP block (spec schema
IpBlockQuestions, property answer).A product (for example an EIA, Fabric or Network Edge resource) that is consuming an IP block.
Values of the
type property of the Fabric v4 IpBlockAsset schema (spec schema IpBlockProductType: the product consuming the IP block).Reference to the most recent change applied to an IP block (carries the change resource href).
IP Version 4 (IPv4) block request nested in a
CustomerRouteIpv4Request.IP Version 6 (IPv6) block request nested in a
CustomerRouteIpv6Request.Metro location of an IP block.
Order details of an IP block.
IP block product breakdown of an Equinix Internet Access (EIA) v1 price entry.
The prefix length (subnet size) of an
IpBlockProductPrice IP family.The product type of an IP block (
IPV4_IP_BLOCK / IPV6_IP_BLOCK).Question/answer pair relevant to requesting public IP space for an Equinix Internet
Access (EIA) v2 service.
RIR justification question asked for a provider-assigned IP block (spec schema
IpBlockQuestions, property type).Regulatory questionnaire answers required when requesting an Equinix-owned IP block.
Regulatory information required when requesting an Equinix-owned IP block (the addressing plans
and questionnaire answers mandated for APAC blocks).
Client interface for managing Equinix Fabric IP blocks (BYOIP / Equinix-owned IPv4 and IPv6
prefixes).
Type discriminator of an Equinix Internet Access (EIA) IP block (spec schemas
IpBlockType / IpBlockReadModel).Detailed IX presence information for a network at a specific Equinix IX.
Service-provider interface that lets each domain contribute its own Jackson
(de)serializers to the SDK's shared
Constants.mapper() without core
having to depend on any domain package.A JSON Web Key Set published by the Equinix Security Token Service, as returned by the STS JWKS
operation.
Read-only JSON model for the STS
JwksResponse.KeyType class.
Request body carrying only a revision marker (spec schema
LastRevBody), used by the IAM
enable/disable operations (e.g.A single latency measurement between a metro and a user site.
One round-trip latency with where it came from.
How a latency figure was obtained.
A metro-by-site latency grid.
Site-weighted round-trip latency from each site to its nearest metro in the portfolio, in ms.
Latency sensitivity tiers for workloads, each with a typical round-trip ceiling
(
thresholdMs).A-Side source patch panel for a cross-connect (
aSide in the cross-connects v2 spec).A single cross-connect deinstallation entry (
Layer1_Deinstall_Details in the
cross-connects v2 spec).Patch equipment to remove during a cross-connect deinstallation.
A single cross-connect entry (
Layer1_Details in the cross-connects v2 spec).Diversified / redundant cross-connect configuration (
diverseConnections in the
cross-connects v2 spec).A-Side of a diversified connection.
Z-Side of a diversified connection.
Redundant connection with existing connections or new connections.
Patch equipment (
patchEquipment in the cross-connects v2 spec): a chargeable additional
service enabling Equinix to install the cross connect from the demarcation panel to your
equipment.Patch panel (
patchPanel in the cross-connects v2 spec): the device with a series of
connector ports that identifies the source/destination location to connect.Z-Side for a cross-connect (
zSide in the cross-connects v2 spec).Client interface for accessing legacy IBX SmartView environmental data.
Client interface for accessing legacy IBX SmartView power data.
Hypermedia link to a Fabric sub-resource (the
links array entries).Connection details of a link protocol (the Fabric v4
LinkProtocolConnection schema):
the connection consuming the VLAN and its bandwidth.Service token details of a link protocol (the Fabric v4
LinkProtocolServiceToken
schema).Values of the Fabric v4
LinkProtocolState schema (the state property of LinkProtocolResponse).Link protocol type (the Fabric v4
LinkProtocolType schema: UNTAGGED,
DOT1Q, QINQ, EVPN_VXLAN, VXLAN).An action available within a service, as returned by the IAM list-actions operation.
The action mapping to access-management permissions, used when performing authorization via
role-assignment token scope (spec schema
RBACPermission).Read-only JSON model for the IAM
ListedAction response.Request body for
POST /v1/accessPoliciesGranted (operationId
listAccessPoliciesGranted, spec schema ListPoliciesGrantedInput) — lists the
access policies granted to the subject identified by a token within a project.A connection as read from Fabric: the fields drift detection compares.
A Cloud Router as read from Fabric: the fields drift detection compares.
A routing protocol as read from Fabric.
A snapshot of the live Fabric resources relevant to one plan, as
LiveStateReader read them
(or as a test builds them).Reads the live Fabric resources relevant to a plan.
Action Data.
Action Request
Action Response
Action State
Action to perform on the LOA.
Change log
Change log metadata for a Digital LOA document (diLOA v1 API).
Reference to the change that produced a Digital LOA document (diLOA v1
Change schema),
returned on LOA creation.The result of a Digital LOA change record (diLOA v1 API).
The Digital LOA state captured in a change record result (diLOA v1 API).
Status of a Digital LOA change record (diLOA v1 API).
Type of a Digital LOA change record (diLOA v1 API).
Associated consumer response
List of Consumers associated with a LOA
A contact person for a Digital LOA party (diLOA v1 API).
A means of contacting a Digital LOA party (diLOA v1 API).
Notification category relevant to a Digital LOA contact (diLOA v1 API).
A cross-connect covered by a Digital LOA product (diLOA v1 API).
A customer organization the current user may use as a Digital LOA requestor (diLOA v1 API).
Specifies the demarcation point.
Issuer
A HATEOAS link describing a follow-up interaction available on a Digital LOA document
(diLOA v1 API).
Relationship of a HATEOAS link to its Digital LOA document (diLOA v1 API).
Data-center location of a Digital LOA patch panel (diLOA v1
Location schema): the IBX
identifier, its region (AMER, APAC or EMEA), metro name/code,
country code and street address.Eligible location where LOA can be issued.
Represents a note added to a LOA by an authorized user from either the issuer or requestor organization
Indicates which party added the note.
List of Loa note details
A party (requestor or provider) on a Digital LOA document (diLOA v1 API).
A patch panel referenced by a Digital LOA cross-connect port (diLOA v1 API).
Connector Type
A patch panel port endpoint of a Digital LOA cross-connect (diLOA v1 API).
A product (service) that a Digital LOA document is valid for (diLOA v1 API).
Type of a product covered by a Digital LOA (diLOA v1 API).
Product type associated with this LOA.
Requestor
Loa Response
LoaResponseOperation model.
Digital Letters of Authorization (LOAs) (10 operations).
Implementation of
Loas over the shared FabricBeta apiParams area.Status of a Digital LOA document (diLOA v1 API).
Current lifecycle state of the LOA.
Type of Letter of Authorization
Typed
serviceDetails for a smart hands locate-package order
(locatePackageRequest.serviceDetails in the smart hands v1 spec).A full location (the Fabric v4
SimplifiedLocation schema).Location (metro/IBX/region) of an Equinix Internet Access (EIA) v2 service.
A simplified location (the Fabric v4
SimplifiedLocation /
SimplifiedLocationWithoutIBX schemas): metro code plus the metro's URI, name
and region.JSON model for the colocation locations response (
locations_details_response).Equinix Fabric Logo Response Object
Company-profile logos (3 operations).
Implementation of
Logos over the shared FabricBeta apiParams area.A permitted IBX location for a customer, with its accounts and cages, as returned by the Customer
Portal Lookup v2 colocation locations API (
locations_details).A media type supported by a connection service, with its protocol types and IFC circuit-count
options (Customer Portal Lookup v2 API).
A protocol type supported by a connection-service media type, with its connector types
(Customer Portal Lookup v2 API).
Client interface for colocation reference-data lookups in the Equinix Customer Portal.
Equinix Managed Services trouble-ticket or service-request notification:
Task.Resource
TroubleTicket.ManagedService or ServiceRequest.ManagedService (spec
ManagedServicesBody).Managed Services notification body.
Impact or urgency level.
Ticket/request details.
Values of the
marketplace property of the Fabric v4 SubscriptionResponse schema.Values of the
offerType property of the Fabric v4 SubscriptionResponse schema.Internal client for Fabric Marketplace Subscriptions (read-only).
Marketplace subscription reference associated with a connection.
Client interface for managing Equinix Fabric marketplace subscriptions.
Values of the
type property of the Fabric v4 marketplaceSubscription schema.Every site's round trip to its nearest portfolio metro must be within
constraints.maxLatencyMs.An NTP MD5 authentication entry (the Fabric v4
md5 schema), used as the items of a
Precision Time service's ntpAdvancedConfiguration.Values of the
type property of the Fabric v4 md5 schema (NTP authentication key type).The streaming envelope shared by every IBX SmartView message type, carrying the
message
type discriminator and its typed data payload.The set of message types a streaming subscription delivers.
Equinix Metal Interconnection reference (
AccessPoint.interconnection), read side only.A streaming metered power reading for an IBX cage, including the account it is billed
to, the originating tag and the measured value with its unit.
Identifies the asset associated with a
MeteredPower reading, including its
type.The streaming envelope wrapping a
MeteredPower payload, carrying the message
type and its data.A
meteredPower message-type entry within a subscription's MessageType
(a subscription filter: account and IBXs).Identifies the monitoring tag associated with a
MeteredPower reading.A measured value paired with its unit, as reported by a
MeteredPower reading.A time-series metric returned by the Equinix Fabric Metrics API.
MetricClient interface.
Internal client for the Fabric Metrics search API (
POST /fabric/v4/metrics/search).MetricDatapoint class.
Read-only JSON model for a Fabric
Metric.A valid
POST /fabric/v4/metrics/search filter, built so that the two expressions the
service requires are always present.MetricResource class.
Client interface for the Equinix Fabric Metrics API (
POST /fabric/v4/metrics/search).Default
Metrics implementation over POST /fabric/v4/metrics/search.Internal client for Fabric Metros (read-only).
Well-known Equinix metro codes.
Case-insensitive
MetroCode deserializer.Destination type of a Metro Connect product (the Fabric v4
/metroConnect/connectionDestinationType price attribute: COLO,
REMOTE, BMMR).Path protection type of a Metro Connect product (the Fabric v4
/metroConnect/pathType
price attribute: PROTECTED, UNPROTECTED, DUAL_DIVERSE).Metro Connect product configuration of a price row (the Fabric v4
metroConnect
member of the Price payload, as returned for METRO_CONNECT_PRODUCT
rows by POST /prices/search): connect type, bandwidth, path protection,
destination type and the A-side/Z-side IBX locations the price applies to.IBX location of a Metro Connect side (wire property
ibxCode).One side (A-side or Z-side) of the priced Metro Connect: the IBX location.
Metro Connect product type of a price row (the Fabric v4
/metroConnect/type
price attribute, e.g.Estimated cost breakdown for a single metro.
constraints.minMetros and constraints.maxMetros.What a run knows about one metro, taken from the live Fabric catalogue.
A forward-compatible identifier for an Equinix metro: a normalized metro code string that can name
any metro, including ones added after this SDK was built and therefore absent from the
MetroCode enum.Metro details as returned by the Network Edge API (
MetroResponse in the
network-edge v1 catalog spec).The Metro Optimizer: which set of Equinix metros best serves a
DesignSpec.Fluent convenience over
DesignSpec: each call adds to the spec, MetroOptimizer.Builder.toSpec() returns it
and MetroOptimizer.Builder.optimize() runs MetroOptimizer.forSpec(FabricGateway, DesignSpec).Sets
DesignConstraints and the budget.Adds one
CloudIntent.Adds one
SiteIntent.Adds one
WorkloadIntent.The set of metros one candidate design deploys in.
Detailed report of all ASN presence at a specific Equinix metro.
A single metro recommendation with composite score, placement rationale,
provider availability, latency data, and cost estimates.
Client interface for querying Equinix Fabric metro locations.
Composite score for a metro recommendation, decomposed into individually
inspectable
ScoreComponent dimensions.A service type supported in a Fabric metro (fabricv4
services - e.g.constraints.minimumRedundancy as an explicit rule on the metro set (see RedundancyTier):
fewest metros, fewest distinct regions, and for N_PLUS_1 two metros sharing a region."min_survival": a portfolio must keep at least a minimum share of its baseline service through its worst
single-element failure (see
N1Survival).A
Clock whose MonotonicClock.millis() advances with System.nanoTime(): it is monotonic,
so a wall-clock adjustment (NTP step, DST, a manual change) can neither shorten nor extend an
elapsed-time measurement.Typed
serviceDetails for a smart hands move-jumper-cable order
(moveJumperCableRequest.serviceDetails in the smart hands v1 spec).Type of a specification connection (
common.yaml#/ConnectionType); carried by
Connection.connectionType.One native provider-to-provider multicloud environment: a pair of cloud regions that two
providers interconnect directly, with no Equinix resource on the path, together with the
availability status observed for it, the source of that observation and the observation date.
An immutable catalog of native provider-to-provider multicloud environments: the pairs of cloud
regions that two providers interconnect directly, with no Equinix resource on the path.
The availability of a native provider-to-provider multicloud environment, as recorded in a
MulticloudEnvironmentCatalog entry on that entry's as-of date.The cost of one cloud-to-cloud flow over each of its two paths: the native multicloud link
(billed by the two cloud providers) and the Equinix path the same flow would use (two Fabric
virtual connections plus the cloud providers' own port fees), with the sustained rate at which
the two cost the same.
The price of one native provider-to-provider multicloud link.
The lookup key for
RateCard.multicloudLink(MulticloudLinkRequest): one native
provider-to-provider multicloud link between two clouds.The relationship between a planned native multicloud link and the Equinix connections that
could carry the same cloud-to-cloud flow.
The cloud-to-cloud section of a
SavingsEstimate: the monthly cost of moving traffic
between two clouds over each of three paths, and the sustained rate at which the flat-fee
native path costs the same as the per-GB Equinix path.How much of a portfolio's baseline service survives its worst single-element failure, measured by
simulation: the shared core of
SimulatedResilienceObjective and MinSurvivalConstraint.Type of action to be carried out with an order negotiation.
Request body for replying to an order negotiation.
The primary entry point for accessing the Equinix Network Edge APIs.
Equinix-side provisioning status of a Fabric network (the
operation.equinixStatus field).Status of a device interface.
Network maintenance or incident notification:
Task.Resource Network.Maintenance
or Network.Incident (schema 1.0), or a ticket-shaped DataCenter.Network.Port /
DataCenter.Network.VirtualConnection notification (the spec maps those 2.0 resources to
NetworkNotificationV2Body; when their body is instead Fabric-shaped, the parser produces a
FabricNotification).Operational data for a Fabric network (the
operation field).Aggregated presence information for a single network (ASN) across all Equinix metros.
Minimal Fabric Network reference (uuid only) for use as an access-point target.
Client interface for managing Equinix Fabric networks.
Network status (the Fabric v4
NetworkState schema: ACTIVE,
INACTIVE, DELETED).Simplified Fabric Network reference returned on an access point (spec schema
SimplifiedNetwork).Network type classification from PeeringDB's
info_type field.What a
GraphNode of a DesignGraph stands for.Request body for adding a note to an order.
An IBX or network notification in the Equinix Customer Portal (Notifications v1
ibx-notification / network-notification).A notification recipient set (the Fabric v4
SimplifiedNotification schema).Category of a unified notification event (Customer Portal Unified Notifications v2 API).
NotificationClient interface.
A recipient of a unified notification event (Customer Portal Unified Notifications v2 API).
A means of contacting a unified notification recipient
(Customer Portal Unified Notifications v2 API).
Type of a unified notification contact (Customer Portal Unified Notifications v2 API).
Email content for an IBX/network notification event (Notifications v1
notification-email).JSON model for a Notifications v1
notification-email.JSON model for an IBX or network notification (Notifications v1
ibx-notification /
network-notification).Product type associated with a unified notification event
(Customer Portal Unified Notifications v2 API).
Client interface for accessing IBX and network notifications in the Equinix Customer Portal.
Request body for searching IBX or network notifications
(
POST /v1/notifications/ibx/search, POST /v1/notifications/network/search).Date-range filter for notification events.
Typed notification filter.
JSON model for an IBX/network notification search response, whose notifications are carried in
the
data array.Field name to sort a unified notifications search by
(Customer Portal Unified Notifications v2 API).
Sort direction for a unified notifications search (Customer Portal Unified Notifications v2 API).
Status of a unified notification event (Customer Portal Unified Notifications v2 API; also covers the
Notifications v1
notification-status values).Type of a unified notification event (Customer Portal Unified Notifications v2 API; also covers the
Notifications v1
ibx-notification-type / network-notification-type values, which add
IBX_SMARTVIEW).Notification Type.
NotificationType class.
The wire body for the OAuth2 token request (
POST /oauth2/v1/token, spec schema
Oauth2TokenRequest): client_id, client_secret and grant_type.An OAuth2 access token as returned by the Equinix token endpoint, plus the local
session-start instant used to judge expiry.
One measurable quality of a portfolio, in its own unit.
What an
Objective measured for one portfolio.An OpenID Connect identity provider registered with the Equinix Security Token Service, as
returned by the STS OIDC provider operations.
Internal client for managing trusted OIDC providers within a root project
(
/v1/projects/{projectId}/oidcProviders).Internal client implementation for STS OIDC providers.
Read-only JSON model for the STS
OIDCProvider response.A paginated list of OIDC providers (spec schema
OIDCProviderPage), as returned by
GET /v1/projects/{projectId}/oidcProviders (operationId pageOidcProviders).FindingCategory.ON_DEMAND_TO_TERM: a live, on-demand connection or Cloud Router, older
than minAgeForTermDays, that is cheaper on one of the candidate terms.The OpenID Connect discovery document for the Equinix Security Token Service, as returned by the
STS OpenID configuration operation.
Read-only JSON model for the STS
OpenIdConfiguration response.Operational status of a resource as reported by the API.
Operational status of the resource targeted by a cloud event (the Fabric v4
OperationalStatus schema).Case-insensitive
OperationalStatus deserializer with a forward-compatible fallback:
a status value this SDK does not yet list maps to OperationalStatus.UNKNOWN rather
than failing the whole response (mirroring MetroCodeDeserializer).An Equinix Internet Access (EIA) operational unit, as returned by the v1 operational-units lookup
(
GET /internetAccess/v1/operationalUnits).The postal address of an Equinix Internet Access (EIA) operational unit.
Internal client for the Equinix Internet Access (EIA) v1 operational-units lookup:
GET /internetAccess/v1/operationalUnits.Internal client implementation for the Equinix Internet Access (EIA) v1 operational-units lookup
GET /internetAccess/v1/operationalUnits.Read-only JSON model for an
OperationalUnit returned by the Equinix Internet Access (EIA)
v1 operational-units lookup (GET /internetAccess/v1/operationalUnits).The location of an Equinix Internet Access (EIA) operational unit.
A-Side configuration.
Originating end as provisioned, with the demarcation point and IBX location.
Dual diverse pair Connection
Specifies the demarcation point: the patch panel and ports at this side.
Type of Connector
Letter of Authorization granting the right to terminate at the Z-side location.
Destination location for BMMR and REMOTE connections.
Notification preferences for this connection.
Notification category.
Ordering and billing reference details for this connection.
Request to order a single connection.
BMMR infrastructure ownership type.
Where the Z-side terminates.
Level of resilience for the connection.
OC - Optical Connect Type
Optical Connect redundancy configuration.
Role within the diverse pair.
Optical Metro Connect connection with its current state and the resolved physical termination points at both ends.
BMMR infrastructure ownership type.
Where the Z-side terminates.
Demarcation point as provisioned, with the cage and cabinet it belongs to.
Type of Connector
Level of resilience for the connection.
Connection Type.
Optical Metro Connect services (4 operations).
Implementation of
OpticalConnects over the shared FabricBeta apiParams area.Optical Connect lifecycle states.
Z-Side configuration.
Terminating end as provisioned, with the demarcation point and IBX location.
Human-readable explanation of the optimization methodology, assumptions,
and data freshness for inclusion in reports.
The run's
DesignSpec restated in the shape the Deployment
Wizard reads: sites, clouds (as ProviderRequirements labelled by the spec's cloud id) and
workloads (as WorkloadSpecs whose dependencies carry the same labels).The result of a Metro Optimizer run.
Named weightings of the optimizer's objectives, each one of the
WeightProfiles profiles.A
RateCard that sources Oracle Cloud (OCI) internet data-egress rates from the
public OCI Price List API
(https://apexapps.oracle.com/pls/apex/cetools/api/v1/products/).Adapter for bridging Oracle Cloud Infrastructure FastConnect SDK objects with Equinix Fabric connections.
An order retrieved from the Equinix Customer Portal (Orders v2).
Order details for an ordered Fabric resource (the Fabric v4
Order schema, used by
Connection and Cloud Router requests and responses).Reference to a previously uploaded attachment (
attachments[]) on a colocation v2 order.A file attached to an order line or note (
Attachment): the binary attachment id
(UUID) and its name.Audit trail of who created, last updated and (optionally) deleted an Equinix Internet Access
(EIA) v1 order, together with the corresponding timestamps.
Internal client for the Equinix Internet Access (EIA) v1 order single get:
GET /internetAccess/v1/orders/{orderUUID}.Internal client implementation for the Equinix Internet Access (EIA) v1 order single get
GET /internetAccess/v1/orders/{orderUUID}.A contact on a colocation v2 order (cross-connect, shipment, work visit) or a v2 trouble
ticket / support case.
A contact associated with an Equinix Internet Access (EIA) v1 order.
A single contact-detail entry (
ContactsRequestDetails) for a non-registered contact.An order contact-detail entry (
ContactsDetails): a communications type
(PHONE, EMAIL or MOBILE) and its value.A related party associated with an order (
Contacts).Role of a contact on an order (Orders v2 API).
The full details of an Equinix Internet Access (EIA) v1 order, as returned by the single get
(
GET /internetAccess/v1/orders/{orderUUID}).Read-only JSON model for an
OrderDetails returned by the Equinix Internet Access (EIA) v1
order single get (GET /internetAccess/v1/orders/{orderUUID}).Client interface for searching order history in the Equinix Customer Portal.
The account on an order history record (
account).A contact on an order history record.
Relative date window for an order-history search (
filters.dateRange).A single order history record (
order-header) returned by an order history search.JSON model for an order history record (
order-header).A HATEOAS link on an order history record or response (
link): the relation rel
(self, prev, next or orderFullDetails) and its href.The relation of an order-history link (
link.rel in the Order History v1 spec).One page of an order history search (
order-history-response): the content
records, the response-level links and the page metadata.Product (order) type for an order-history search (
filters.productTypes,
POST /v1/retrieve-orders).Request body for searching order history
(
POST /v1/retrieve-orders, OrderHistoryAPIRequest).Builder for
OrderHistorySearchRequest.Filters for an order history search:
ibxs, productTypes, orderStatus,
a relative dateRange (for example OrderHistoryDateRange.PAST_30_DAYS) or an
absolute fromDate/toDate window (YYYY-MM-DD).Builder for
OrderHistorySearchRequest.Filters.Paging request: the zero-based page
number and the page size (spec maximum 200).A sort directive: the field
name and the direction.JSON model for the order history search response (
order-history-response).Paging details for an order history search response (
page-details-for-response).Fields a free-text order-history query (
q) is matched against (source).Sort field for an order-history search (
sorts[].name).Status of an order-history header: the
orderStatus of a result and the
filters.orderStatus of a search (POST /v1/retrieve-orders).JSON model for an order (
Orders = ordersBase + OrderDetails) from the
Orders v2 API.A single order line item (
ordersLine).Request type of an order line (Orders v2 API).
A HATEOAS link describing a follow-on action available on an Equinix Internet Access (EIA) v1
order.
A negotiation message on an order, proposing an alternative date and time for fulfilling
the order request.
A note associated with an order (
Note): its id and referenceId,
createdDateTime, free-text text, author, type
(CUSTOMER_QUERY, CUSTOMER_NOTES, TECHNICIAN_QUERY or
TECHNICIAN_NOTES) and any attachments.Type of a note on an order (Orders v2 API).
Order status notification for orders placed through the Customer Portal, the APIs or EMG
(Cross Connect, Smart Hands, Work Visit, Shipment, Trouble Ticket, ...):
Task.Resource one
of the spec's order product groups (SmartHands, Shipping, WorkVisit, ...).An order attachment.
Order notification body (spec
OrderNotificationBody).Order state.
Pricing details (
price) for an order line: a value together with its
valueType (ABSOLUTE or PERCENTAGE) and charge type
(ONE_TIME_CHARGE, MONTHLY_CHARGE, MONTHLY_DISCOUNT or
ONE_TIME_DISCOUNT).Product type of an order line (Orders v2 API; also
quote_details.productType in the Quotes v2 spec,
which adds CLOUD_EXCHANGE_PORTS).The purchase order referenced by an order line (
purchaseOrder): its type
(EXEMPTED, NEW or EXISTING), number and closingDate.Purchase order reference (
purchaseOrder) for a colocation v2 order.Purchase order referenced by an Equinix Internet Access (EIA) v1 order.
Common order details shared by Fabric order references: the order resource
href, the
customer purchase-order number, and the resolved order number / order line.Cross Connect Order.
Result of submitting a colocation order, carrying the generated order identifier.
Cross Connect Order.
JSON model for an order submission result.
Client interface for managing colocation orders in the Equinix Customer Portal.
Signatory of the order signature attached to an Equinix Internet Access (EIA) v2 service order.
Signature configuration of an Equinix Internet Access (EIA) v2 service order.
Delegate the signature request is sent to when the signatory is
DELEGATE.Order signature (
OrderSignature) supplied in the order of an Equinix Internet
Access (EIA) v2 service create.Delegate the signature request is sent to when the signatory is
DELEGATE.Processing state of an Equinix Internet Access (EIA) v1 order.
A resource a rollback could not remove.
Typed
serviceDetails for a smart hands other (ad-hoc) order
(otherRequest.serviceDetails in the smart hands v1 spec).Details for creating an outbound shipment (
OutboundShipments_create in the shipments v2
spec).Request body for submitting an outbound shipment order
(
POST /v1/orders/shipment/outbound, outboundShipmentRequest in the shipments v1
spec).Service details for an outbound v1 shipment order (
outboundServiceDetail in the
shipments v1 spec).Details of the outbound shipment itself (
outboundServiceDetail.shipmentDetails).The destination address of an outbound shipment
(
outboundServiceDetail.shipmentDetails.shipToAddress).Details for updating an outbound shipment (
OutboundShipmentsUpdate in the shipments v2
spec).Structured output of a Cloud Router ping command (spec schema
OutputStructuredPing).A single ICMP echo response from a Cloud Router ping command
(spec schema
OutputStructuredPingResponseItem).Structured output of a Cloud Router traceroute command
(spec schema
OutputStructuredTraceroute).Package settings for a port (the Fabric v4
Package schema - the
Port.package response attribute).Type of port package (the Fabric v4
Package.code / PortSettings.packageType
attribute: STANDARD, UNLIMITED, UNLIMITED_PLUS).A deserialized page of a list/search response: the raw JSON items plus the response's
pagination metadata and the request/response pair used to fetch it (for lazy paging).
A client that can fetch the next page of a POST-based search and map the response.
A paginated, filtered list of resources returned by Equinix API search operations.
A paginated list of resources returned by Equinix API list operations.
A POST-search request body that carries client-side pagination state, so the shared paging
pipeline (
PaginatedList/PaginatedFilteredList next()/loadAll())
can re-point the body at the next page between fetches without knowing the body's concrete type
or how it represents pagination.Request carrier for POST-based search operations whose paging state lives in the request
body (a
PaginatedPostBody) rather than in
offset/limit query parameters.Request carrier for offset/limit-paginated GET list operations.
Client-side pagination state serialized into POST-search request bodies and advanced by the
paging pipeline between page fetches.
Pagination metadata returned by Equinix API list operations.
Pagination response information
Builds query-parameter maps and single-value parameter lists for request construction, and
formats query-string values (e.g.
Pareto dominance over rows of objective values.
Type of a Digital LOA party (diLOA v1 API).
Typed
serviceDetails for a smart hands patch-cable-install order
(patchCableInstallRequest.serviceDetails in the smart hands v1 spec).Typed
serviceDetails for a smart hands patch-cable-removal order
(patchCableRemovalRequest.serviceDetails in the smart hands v1 spec).Patch equipment installed for the Cross Connect.
Patch equipment installed for the Cross Connect.
Request body for modifying an existing OIDC provider via
PATCH
/v1/projects/{projectId}/oidcProviders/{idpId} (operationId patchOidcProvider, spec
schema PatchOidcProviderBody).A single RFC 6902 (JSON Patch)
operation -
{"op": ..., "path": ..., "value": ...}.A patch panel available for cross-connect ordering.
A patch panel in an Equinix IBX data center, as returned by the Equinix Internet Access (EIA)
v1 product-availability lookup
GET /internetAccess/v1/patchPanels.Internal client for the Equinix Internet Access (EIA) v1 product-availability lookup:
GET /internetAccess/v1/patchPanels - the patch panels a customer has in a given cage
and cabinet.Internal client implementation for the Equinix Internet Access (EIA) v1 product-availability
lookup
GET /internetAccess/v1/patchPanels.JSON model for a patch panel.
Read-only JSON model for a
PatchPanel returned by the Equinix Internet Access (EIA) v1
product-availability lookup GET /internetAccess/v1/patchPanels.An owned (used or reserved) port on a patch panel in the Equinix Internet Access (EIA) v1
product-availability lookup (
GET /internetAccess/v1/patchPanels).Type of a patch panel (Customer Portal Lookup v2 API).
Type of patch panel in an Equinix Internet Access (EIA) v1 product-availability lookup
(
GET /internetAccess/v1/patchPanels).Status of a payment on a billing account (Billing v1 finance accounts API).
PDU configuration in a secure cabinet product availability response (
PduConfig schema).Reference to the connection a peering is associated with, by
uuid.Lightweight HTTP client for the PeeringDB REST API.
Represents a data center facility from the PeeringDB API.
Represents an internet exchange point from the PeeringDB API.
Represents a network's presence at a facility from the PeeringDB API.
Represents a network's presence at an internet exchange LAN from the PeeringDB API.
Represents a network (autonomous system) from the PeeringDB API.
Represents an organization from the PeeringDB API.
Entry point for Peering Intelligence - an interconnection analysis tool that combines
PeeringDB IX peering data with Equinix Fabric private connectivity data to produce
unified presence matrices, resiliency assessments, and peering opportunity discovery.
Fluent builder for configuring and executing a peering intelligence analysis.
Top-level result of a peering intelligence analysis.
Represents a mutual IX presence - an Equinix IX where both the customer's ASN and a target
ASN are connected, and peering could therefore be established (or may already exist).
Peering policy classification from PeeringDB's
policy_general field.Captures all inputs for a peering intelligence analysis.
A network the design wants to exchange traffic with, identified by its autonomous system number.
Where a peer network is present, for drawing it into a
DesignGraph.One dry-run-validated proposal awaiting confirmation: the single-use confirm token, the
change type, the exact canonicalized spec the dry run validated (the confirm phase
recompiles this stored spec - never a re-supplied one), the SHA-256 of the compiled request the
token is bound to, the mint and expiry instants, and the price context the proposal reported.
Request body for submitting a pending inbound shipment (pending storage) order
(
POST /v1/orders/shipment/pendingStorage, pending-storage-request in the
shipments v1 spec).One stored shipment to deliver (
pending-storage-request.shipmentDetails item).One entry of the result of submitting a pending storage shipment order
(
pending-storage-order-response item in the shipments v1 spec) - the API returns one
entry per stored shipment submitted, identifying the created order and the storage, location
and account it applies to.JSON model for one entry of the pending storage shipment order result
(
pending-storage-order-response item in the shipments v1 spec).A location the current user may filter order history by: an IBX and its permitted cages.
JSON model for an order history
permissible-location element.A named, reusable set of permissions within a project, as returned by the IAM permission set
operations (
listPermissionSets, createPermissionSet, getPermissionSet,
updatePermissionSet).Internal client for project-scoped IAM permission sets
(
/v1/projects/{projectId}/permissionSets).Internal client implementation for project-scoped IAM permission sets.
Read-only JSON model for the IAM
PermissionSet response.Token-paginated JSON model for the IAM
PermissionSetList response schema.Phone model.
Preferred time window to call a contact's phone number (
workPhonePrefToCall /
mobilePhonePrefToCall in smarthandsv1, shipmentsv1 and troubleticketv1).Notification Type
A physical member port backing a virtual port (the Fabric v4
PhysicalPort schema).Response body for the add-to-LAG (bulk physical port) endpoint
(
POST /fabric/v4/ports/{portId}/physicalPorts/bulk, schema AllPhysicalPortsResponse):
the full list of physical ports backing the virtual port after the addition, with pagination.Physical media/optic type of a Fabric physical port (the
physicalPortsType attribute of
PortRequest).Typed
serviceDetails for a smart hands pictures/document order
(picturesDocumentRequest.serviceDetails in the smart hands v1 spec).The rates pinned in a spec's
commercial.exchangeRates: units of the spec currency per one unit of
each keyed currency.Every workload with a
pinnedMetro needs that metro in the design.Where every workload of a spec runs on one portfolio, and the cloud connections that implies.
One Fabric connection the design needs: from a metro to a cloud, sized as the sum of the sized
workloads it carries.
Where one workload runs.
A workload as the graph sees it: where it runs, where it fails over to and what it needs.
A plan compared with live state: one
ResourceDrift per planned element, the live resources
that carry the plan's marker but are not in it, and notes on anything that could not be read.Executes and reconciles deployment plans.
Billing frequency of a Smart Hands support plan.
Reads and writes a
DeploymentPlan as JSON and computes its content identity.How resources created from a plan are marked so drift detection and reconcile can find them again.
An inter-metro Fabric backbone link between two Cloud Routers, enabling private connectivity
between deployment metros.
A Cloud Router (FCR) to be created as part of a deployment plan.
A Fabric connection to be created as part of a deployment plan.
A Fabric Interconnect (the managed routed network behind Fabric One) that a deployment plan
includes, but that this SDK cannot create.
A native provider-to-provider multicloud link carried on a
DeploymentPlan: a direct
connection between two clouds (for example AWS Interconnect - multicloud paired with a Google
Cloud Partner Cross-Cloud Interconnect transport) that uses no Equinix resource.One Cloud Router to cloud connection of the Equinix path for the flow.
A routing protocol configuration to be applied to a planned connection.
Aggregated pricing breakdown for a complete deployment plan, including
Cloud Router costs, provider connection costs, and backbone link costs.
Tears down resources a run created, in an order that cannot strand a billable Cloud Router.
One element of a plan in its uniform, dependency-ordered form: what
PlanSteps.of(DeploymentPlan) derives
from a DeploymentPlan for execution, reconcile, drift detection and checkpoints.Derives the dependency-ordered
PlanSteps of a plan: Cloud Routers, then provider
connections (a redundancy group's PRIMARY before its SECONDARY), then backbone links, then routing
protocols (DIRECT before BGP on the same connection, as Fabric requires), then the elements the SDK
does not create (Interconnects and native multicloud links).Layered, plan-time validation for the Deployment Wizard.
The classification of a single live-layer failure.
Whether a live-layer failure is a genuine rejection (a plan defect) or an infeasibility (a skip).
The outcome of validating a plan, in three distinct buckets - hard/rejection errors (which
invalidate the plan), deferred validations (which do NOT - they run at provisioning), and
skipped validations (which do NOT - they could not be attempted now, each with a reason) -
plus the per-connection customer inputs a first-time customer must gather.
Fluent builder, returned by
DeploymentPlan.valueRealization(), that
computes the egress savings a deployment plan produces once the caller declares
their per-provider monthly egress volumes, net of the plan's cost.The value-realization view of a
DeploymentPlan: the monthly cloud-egress
saving the plan's private interconnects produce (versus public-internet egress),
netted against the plan's actual Equinix interconnect cost.The egress-saving row for one declared cloud provider: the internet-egress cost the
declared volume would incur, the private-interconnect cost the plan enables instead, and
the difference.
Change log
A lossless, typed wrapper for the polymorphic
oneOf union members used throughout the IAM
access-control schemas - the permissions/intersect/subtract entries of an
AccessPolicy, PermissionSet and PrincipalPolicy, and the
managedPolicies/managedPermissionSets/subtract fields of a
PolicyMask.A policy mask that constrains the managed policies and permission sets available to a
principal, as returned by the IAM policy-mask operations.
Internal client for project-scoped IAM policy masks
(
/v1/projects/{projectId}/policyMasks).Internal client implementation for project-scoped IAM policy masks.
Read-only JSON model for the IAM
PolicyMask response.Token-paginated JSON model for the IAM
PolicyMaskList response schema.Additional key/value information attached to a port (the Fabric v4
PortAdditionalInfo schema).Current state of the latest port change (the Fabric v4
PortChange schema).Port change operation data (the Fabric v4
PortChangeOperation schema) - a
JSON-Patch-style triple of operation name, document path and new value.Internal client for Fabric Ports.
Connection A-side access point of an Equinix Internet Access (EIA) v1 port configuration.
Connection A-side of an Equinix Internet Access (EIA) v1 port configuration.
Connection allowance of an Equinix Internet Access (EIA) v1 port configuration.
Physical-port details of an Equinix Internet Access (EIA) v1 port configuration.
Port allowance of an Equinix Internet Access (EIA) v1 port configuration.
Routing-protocol allowances of an Equinix Internet Access (EIA) v1 port configuration.
Per-IP-version (IPv4 / IPv6) routing allowances of an Equinix Internet Access (EIA) v1 port
configuration.
An allowed port configuration for an Equinix Internet Access (EIA) v1 service, as returned by
GET /internetAccess/v1/portConfigurations.Internal client for the Equinix Internet Access (EIA) v1 port-configuration lookup:
GET /internetAccess/v1/portConfigurations - the allowed port configurations for a given
IBX and use case.Internal client implementation for the Equinix Internet Access (EIA) v1 port-configuration lookup
GET /internetAccess/v1/portConfigurations.Read-only JSON model for a
PortConfiguration returned by the Equinix Internet Access (EIA)
v1 lookup GET /internetAccess/v1/portConfigurations.Typed request body for creating a single Fabric port (
POST /fabric/v4/ports, schema
PortRequest).Request-side account reference (
SimplifiedAccountRequest): the account number under
which the port is created.Request-side location reference (
SimplifiedLocationRequest): the metro in which the
port is provisioned.The priced lines of one portfolio plus the items that could not be priced.
Port interface details (the Fabric v4
PortInterface schema).Physical port interface details of an Equinix Internet Access (EIA) v1 product configuration
(e.g.
Physical port interface type of an Equinix Internet Access (EIA) v1 dedicated port configuration
(spec schema
DedicatedPortDefaultConfiguration...physicalPort.interface, property
type).Letter of authorization attached to a port (the Fabric v4
PortLoa schema).Notification preference of a port (the Fabric v4
PortNotification schema).Notification preference type of a port notification contact (the Fabric v4
PortNotification.type attribute: NOTIFICATION, TECHNICAL,
PEERING, ESCALATION).Fluent create/update entry point for Fabric ports, mirroring the route-filter operator.
Order details associated with a port (the Fabric v4
PortOrder schema).Purchase order information associated with a port order (the Fabric v4
PortOrderPurchaseOrder schema).Port order signature details (the Fabric v4
PortOrderSignature schema).Order delegate details for a port order signature (the Fabric v4
PortOrderSignatureDelegate schema).Ownership state of a patch-panel port in an Equinix Internet Access (EIA) v1
product-availability lookup (
GET /internetAccess/v1/patchPanels).Type of entity that owns a patch-panel port in an Equinix Internet Access (EIA) v1
product-availability lookup (
GET /internetAccess/v1/patchPanels).A Fabric port package describing the capabilities available for a class of ports.
Internal client for Fabric Port Packages (read-only).
Client interface for querying Equinix Fabric port packages (read-only).
Port source types supported by a port package (spec schema
PortPackageSourceType).Response wrapper for
GET /fabric/v4/portPackages, which returns a non-paginated
{ "data": [...] } envelope.Values of the
type property of the Fabric v4 PortPackage schema.Values of the
type (and deprecated selectionType) properties of the Fabric v4 PortOrderPurchaseOrder schema.Client interface for managing Equinix Fabric ports.
Identifies the service type associated with a port (the Fabric v4
PortServiceCode
schema: CX, IX, IA, MC).Port service type (the deprecated Fabric v4
Port.serviceType attribute:
EPL, MSP).Values of the
signatory property of the Fabric v4 PortOrderSignature schema.Port reference returned on an access point (spec schema
SimplifiedPort).XF_PORT is the sole PortType value defined by the Fabric spec.A VLAN (link protocol) configured on a Fabric port.
Defines the condition that triggers a power alert.
Read-only model representing a power alert configuration returned by the IBX SmartView
power-events API.
An asset included in a power alert configuration.
Response returned after successfully creating a power alert configuration.
Request body for creating a power alert configuration.
Fluent builder for creating and updating IBX SmartView power alert configurations.
Request body for updating an existing power alert configuration.
A contact method (SMS or email) for power alert notifications.
Information about the user who created a power alert configuration.
A recipient to be notified when a power alert condition is met.
Threshold configuration for a power alert condition.
Identifies the asset associated with a
PowerMessage, including its type.Typed request body for the legacy
/power/v1/current POST endpoint
(PowerCurrentPostRequest).Current power consumption data for a single hierarchy node, wrapped in the
payLoad/status envelope returned by the legacy /power/v1/current
GET endpoint.The
payLoad of a PowerData response.A single power data entry within the
payLoad.data array returned by the legacy
/power/v1/current POST endpoint (PowerData_IBX in the spec).Deserialization holder for the legacy
/power/v1/current POST response
(PowerDataResponse_IBX), which wraps a data array inside a
payLoad envelope alongside the status object.Read-only model representing a single IBX SmartView power event.
Asset information associated with an IBX SmartView power event.
Processing-time information for an IBX SmartView power event.
Client interface for the IBX SmartView power-events API (
/dcim/v3/powerEvents).Deserialization holder for the
/dcim/v3/powerEvents/search response.A node in the recursive power hierarchy tree returned by
/smartview/v1/hierarchy/power.Power-hierarchy level type used by the DCIM power APIs.
A streaming power message for an IBX cabinet, carrying a comprehensive set of power
measurements (real, apparent, contractual, current, power factor and seven-day peaks)
each paired with its unit.
The streaming envelope wrapping a
PowerMessage payload, carrying the message
type and its data.The shared power-reading shape for a single hierarchy node, common to both the
payLoad of a GET /power/v1/current response (PowerData.Payload)
and an entry in the payLoad.data array of a POST /power/v1/current
response (PowerDataIBX).A measured value paired with its unit, reused for every power measurement carried by
a
PowerMessage.Request body for creating a Precision Time service (the Fabric v4
precisionTimeServiceRequest schema).EPT (Precision Time) service network information (the Fabric v4
ipv4 schema):
the primary and secondary timing-server addresses, network mask and default gateway.Order details for a Precision Time service (the Fabric v4
precisionTimeOrder schema).Precision Time service level (the Fabric v4
precisionTimePackageRequest schema):
carries the package code.Pricing for a Precision Time service (the Fabric v4
precisionTimePrice schema):
the offering currency and its PriceCharge entries.Client interface for managing Equinix Fabric Precision Time services.
A single cell in the
PresenceMatrix, representing one ASN's presence
at one Equinix metro.A two-dimensional matrix of ASN presence across Equinix metros.
An Equinix Internet Access (EIA) v1 price entry, as returned by the price search
POST /internetAccess/v1/prices/search.The plausible range of a price, derived only from where it came from.
Price category (the Fabric v4
PriceCategory schema, surfaced on Price under the
spec's own catgory spelling).Category of an Equinix Internet Access (EIA) v1 price entry.
A single charge line of an Equinix Internet Access (EIA) v1 price entry.
Charge type of an Equinix Internet Access (EIA) v1 price charge - whether the charge recurs
monthly or is a one-off (non-recurring) charge.
Billing unit of an Equinix Internet Access (EIA) v1 price charge:
ITEM for fixed
(per-item) billing, GB_1 per gigabyte, or MBPS_1 per megabit-per-second.Internal client for the Equinix Internet Access (EIA) v1 price search:
POST /internetAccess/v1/prices/search.Internal client implementation for the Equinix Internet Access (EIA) v1 price search
POST /internetAccess/v1/prices/search.Read-only JSON model for a
Price returned by the Equinix Internet Access (EIA) v1
price search POST /internetAccess/v1/prices/search.Location of a priced product (the Fabric v4
PriceLocation schema): metro code and IBX.The answer to one rate-card lookup: the figure, or the reason there is none, plus which card
answered and why earlier cards declined.
An immutable price for a single resource, split into its monthly-recurring
(MRC) and non-recurring (one-time setup, NRC) components, tagged with the
PriceSource it was resolved from.Client interface for querying Equinix Fabric pricing information.
Request body (
FilterBody) for searching Equinix Internet Access (EIA) v1 prices via
POST /internetAccess/v1/prices/search.Identifies where a
PriceQuote came from, so every number in a cost
estimate or savings calculation is traceable to its origin and disclaimed
appropriately.Summarized pricing for an Equinix Internet Access (EIA) v1 price entry: the individual
charges plus a single roll-up total charge.
The roll-up total charge of a
PriceSummary.Fabric price product type (spec schema
ProductType).Z-side bridge pricing attributes (spec schema
VirtualConnectionPriceZSide_accessPoint_bridge).Access point port pricing attributes (spec schema
VirtualConnectionPriceASide_accessPoint_port).The live-pricing time budget of one tool call:
ServerContext.pricingTimeoutMillis()
milliseconds, shared by every pricing lookup the call makes (cloud provider price lists and the
Equinix rate card alike).Charge type of an order line price (Orders v2 API; also
pricingDetails.type in the Quotes v2 spec,
which adds the NET_* and TAX values).One side of a priced connection:
{"accessPoint": {...}}.How an order line price value is expressed (Orders v2 API).
An access policy attached directly to a principal (user), as returned by the IAM
principal-policy operations.
Internal client for project-scoped IAM principal policies
(
/v1/projects/{projectId}/principalPolicies).Internal client implementation for project-scoped IAM principal policies.
Read-only JSON model for the IAM
PrincipalPolicy response.Token-paginated JSON model for the IAM
PrincipalPolicyList response schema.Reference to a prior invoice or credit memo adjusted on an invoice summary (Billing v2 API).
Request body for requesting Digital LOA private beta access
(
POST /diloa/v1/privateBetaAccess).Whether the current user is permitted to use the Digital LOA application in its private beta
phase (diLOA v1 API).
A private service reference returned when listing the private services attached to a company
profile.
Response wrapper for
GET /fabric/v4/companyProfiles/{companyProfileId}/privateServices,
which returns a non-paginated { "data": [...] } envelope.Secure cabinet product availability for an IBX, describing the cabinet capacity and power
configuration that may be ordered at a given location.
JSON model for a secure cabinet
ProductsAvailability element.Product attribution for a single charge of an Equinix Internet Access (EIA) v1 price entry.
Product offering of a connection z-side access point (spec 4.34.0
ProductOffering,
"applicable to zSide only"; example Colo2Sp-LMaaS-Primary).A single charge line of an Equinix Internet Access (EIA) v1 price entry's top-level
charges array.Product type of an Equinix Internet Access (EIA) v1 price entry.
One service profile that can carry a given connection's bandwidth, as a typed decision point the
wizard exposes instead of silently picking.
How the wizard chose a service profile and a billable bandwidth for one provider connection - the
bandwidth-aware selection made visible rather than hidden.
Project model.
A project associated with a root organization, as returned by the Equinix Resource
Manager.
Internal client for the read-only Equinix Resource Manager projects endpoint.
Internal client for the read-only Equinix Resource Manager projects endpoint
(
GET /resourceManager/v2/projects).Converts between the two project-identifier formats.
JSON model for a project (read-only).
Client interface for the read-only Equinix Resource Manager projects endpoint.
A user permission entry on a project resource, returned only when the list request is made
with the
includePermissions query parameter enabled.Resource-manager project an Equinix Internet Access (EIA) v2 service belongs to.
The primary entry point for accessing Equinix Projects APIs.
In-memory, TTL-bounded, single-use store for the Safe Mutation Broker's pending proposals,
keyed by confirm token.
The result of one consume attempt.
How a
ProposalStore.consume(String) attempt resolved.Cross-connect protocol type (
protocol_types in the cross-connects v2 spec).A provider available as the A-side of a cross-connect order.
Indicates whether a specific provider is available at a metro,
and if so, which seller regions are supported.
Resolves each
CloudIntent of a spec to the Fabric service profiles that serve it and the
metros those profiles publish: the source of reachableClouds per metro.Maps each recommended metro to the providers available there.
Share of the spec's clouds reachable privately from at least one portfolio metro, 0 to 100.
The Fabric v4
ProviderEnvironment schema: a provider environment of an
IC_PROFILE service profile.Write-side reference to a provider environment: the
uuid property of the Fabric v4
ProviderEnvironment schema and nothing else.Values of the Fabric v4
ProviderEnvironmentTypeEnum schema (the type property of ProviderEnvironment).JSON model for a cross-connect
provider.A provider id from the Connection Coordinator specification: the
{provider} segment of
the resource name providers/{provider}.A provider or service that must (or should) be reachable from the recommended metros.
One side of a specification environment: a provider and that provider's own name for a site
(
environment.yaml#/ProviderSites: providerId, site,
displayName).Trust status of an OIDC identity provider (STS v1 spec schema
ProviderStatus):
ENABLED means token exchange is enabled, SUSPENDED means token exchange for ID
tokens from this provider is currently disabled.A single resource that was created during deployment execution - the audit-trail entry a
DeploymentOutcome carries for every create that succeeded, including resources that
were subsequently torn down by an abort-and-rollback.An error recorded while executing a deployment plan - a resource that could not be
provisioned, a pre-flight or waiter observation, or a rollback deletion that failed.
Provisioning state of a specification feature (
common.yaml#/ProvisioningState); carried
by Feature.provisioningState.Provisioning type of a patch panel order (Customer Portal Lookup v2 API).
PTP advanced configuration for a Precision Time service (the Fabric v4
ptpAdvanceConfiguration schema).Values of the
timeScale property of the Fabric v4 ptpAdvanceConfiguration schema.Values of the
transportMode property of the Fabric v4 ptpAdvanceConfiguration schema.An SSH public key (
PublicKeyResponse in the network-edge v1 catalog spec).The getPublicKeys endpoint returns a
GetPublicKeysResponse object
({pagination, data:[...]}), not a flat array, so the list is read out of the
data property here.Client interface for managing SSH public keys on Network Edge.
Public Peering Connection
PublicPeeringConnectionResponse model.
Purchase Order information associated with the account.
A purchase order available to a billing account, as returned by the Equinix Internet Access (EIA)
v1 purchase-order lookups - the list (
GET /internetAccess/v1/accounts/{accountNumber}/purchaseOrders)
and the single get (GET /internetAccess/v1/accounts/{accountNumber}/purchaseOrders/{number}).Billing account a purchase order belongs to, as returned by the Equinix Internet Access (EIA) v1
purchase-order lookups.
Service category a purchase order applies to, as used by the Equinix Internet Access (EIA) v1
purchase-order lookups.
Internal client for the Equinix Internet Access (EIA) v1 purchase-order lookups:
GET /internetAccess/v1/accounts/{accountNumber}/purchaseOrders (list) and
GET /internetAccess/v1/accounts/{accountNumber}/purchaseOrders/{number} (single get).Internal client implementation for the Equinix Internet Access (EIA) v1 purchase-order lookups
GET /internetAccess/v1/accounts/{accountNumber}/purchaseOrders (list) and
GET /internetAccess/v1/accounts/{accountNumber}/purchaseOrders/{number} (single get).Purchase order reference for a smart hands order.
Read-only JSON model for a
PurchaseOrder returned by the Equinix Internet Access (EIA) v1
purchase-order lookups — the list (GET /internetAccess/v1/accounts/{accountNumber}/purchaseOrders)
and the single get (GET /internetAccess/v1/accounts/{accountNumber}/purchaseOrders/{number}).IBX location a purchase order applies to, as returned by the Equinix Internet Access (EIA) v1
purchase-order lookups.
Lifecycle status of an Equinix Internet Access (EIA) v1 purchase order.
Purchase order selection type (SmartHands orders + Orders v2 line-item purchase orders).
Purchase Order type.
Purchase order type for an Equinix Internet Access (EIA) v2 service order.
Purpose of a provider-assigned (PA) IP block requested for an Equinix Internet Access (EIA) v2
service, supplied for regulatory reasons.
Shared builder for assembling an optional query-parameter map.
A quote retrieved from the Equinix Customer Portal (Quotes v2).
A related party associated with a quote (
Contacts).A quote contact-detail entry (
ContactsDetails): a communications type
(PHONE, EMAIL or MOBILE) and its value.The role of a quote contact (
Contacts.type in the Quotes v2 spec).A single quote line item (
quote_details).JSON model for a quote (
quote_response = quote_response_base + details[])
from the Quotes v2 API.Pricing details (
pricingDetails) for a quote line or grand total: a value together
with its valueType (ABSOLUTE or PERCENTAGE) and charge type
(e.g.Quote request type of an order (Orders v2 API).
Client interface for retrieving quotes in the Equinix Customer Portal.
A quote terms-of-use entry (
termsOfUse_Details): a value measured in
period (MONTHS or DAYS) for a given term type
(INITIAL_TERM, RENEWAL_TERM or NON_RENEWAL_NOTICE).The scoring rules shared by
ExhaustiveSolver and SensitivityAnalysis, so a re-ranking
under other weights or over a relaxed set uses exactly the arithmetic the solver used.A source of unit prices for the design-time cost, savings, and TCO models.
Configures a
RateCardCostModel.A single sensor reading (value + unit) for an environmental sensor.
RebootStatus class.
One section of a
DesignDecisionRecord: its content, or why there is none.Whether a section was produced.
Redundancy configuration shared by the spec's
PortRedundancy (enabled,
group, priority) and ConnectionRedundancy (group,
priority) schemas.Redundancy configuration of an Equinix Internet Access (EIA) v1 product configuration.
The least redundancy a design accepts.
A
RateCard backed by a bundled, dated table of indicative reference
figures - published cloud-provider egress rates, interconnect port fees, and
on-prem/colocation midpoints - compiled so the value-realization models work out
of the box without a live connection or caller-supplied rates.The three Equinix geographic regions.
Region of the Equinix legal entity that issued a billing document (Billing v2 API).
Geographic region of an Equinix IBX data center where Internet Access is available.
A resource a rollback deleted and confirmed gone (
DEPROVISIONED or HTTP 404).A generated report in the Report Center (Reports v1
downloadable-report for the list view,
report for the detail view).Category a report definition belongs to (
reportRequest.categories[] in the Reports v1 spec).Whether the user is entitled to use a report definition (
reportRequest.control in the Reports v1 spec).JSON model for a Reports v1 report definition (
reportRequest); returned by
GET /v1/reportCenter/reports/definitions and
GET /v1/reportCenter/reports/definitions/{reportName}.JSON model for a Report Center report.
An input parameter for a report (Reports v1
parameter).JSON model for a Reports v1
parameter.Data type of a report parameter (
parameter.type in the Reports v1 spec).The data period a report covers (
period in the Reports v1 spec).Client interface for the Report Center in the Equinix Customer Portal.
Status of a scheduled report entry (
scheduleStatus in the Reports v1 spec).Schedule type of a report (
scheduleType in the Reports v1 spec).Sort order for
GET /v1/reportCenter/reports (sorts, Reports v1 spec).Status of a generated report (
reportStatus in the Reports v1 spec).Assembles
EquinixRequest instances: instantiates the right request subtype for the
operation's RequestType, derives the response JavaType from the resource's
JSON class, and resolves the endpoint's URI template ({$token} placeholders) against
the request's properties and path parameters.The single request-body representation carried by an
EquinixRequest.The shape of the body: a JSON payload, form fields, or pre-encoded raw bytes.
Query builders for Customer Portal list calls.
Query filter for billing v2
GET /v2/invoices and GET /v2/invoices/details.Abstract RequestBuilderBase class.
Converts a fully-populated
EquinixRequest into the Apache HttpRequestBase that is
actually sent on the wire: resolves the URI (endpoint + resource path + encoded query parameters),
picks the method-specific Apache request class (including the body-carrying
HttpDeleteWithBody when a DELETE has a body), builds the wire entity from the request's
RequestBody (serializing JSON payloads, encoding form fields, or attaching raw bytes),
and copies the request headers.Every required cloud must be reachable from at least one metro of the design, and every workload must
reach each required cloud it names from the metro it is placed in (a workload runs in one metro).
Every metro in
constraints.requiredMetros must be part of the design.The design must have at least one metro in every region of
constraints.requiredRegions.Analyses how a design survives failures: builds its
DesignGraph, simulates every single failure
(exhaustively) and pairs of failures (bounded), ranks the blast radius, finds single points of failure
and correlated risks, estimates availability and proposes remediation, re-simulating it where it can.The finding types a
ResilienceReport carries.Two (or more) elements that are meant to back each other up but share a failure domain.
An N-1 or N-2 verdict level.
The N-1 or N-2 verdict.
What the pairwise (N-2) simulation covered.
One scenario in the blast-radius ranking (worst first).
A concrete change and the scenarios it addresses.
How serious a correlated risk is.
A single element whose failure causes an outage.
What survives the worst single-metro loss, 0 to 100: the mean of up to three shares, each measured
after removing the metro whose loss hurts most.
How a design graph is built and simulated.
Contributes the simulation-based resilience plug-ins to the Metro Optimizer:
the
SimulatedResilienceObjective ("simulated_resilience"), simulated only when
the spec weights it;
the MinSurvivalConstraint ("min_survival"), inert unless a threshold is given
here, by the spec's constraints.minSurvivalPct, or by the spec label
"design.min_survival_pct" (the field wins over the label);
the FailoverGeoZonesConstraint ("geo_zones_failover"), inert unless the spec
states geo zones.
The resilience analysis of one design: its graph, what every failure scenario leaves working, the
blast-radius ranking, single points of failure, correlated risks, N-1 and N-2 verdicts, estimated
availability and remediation.
Comprehensive resiliency assessment for a customer's connectivity posture.
Generic base for internal resource clients, collapsing the request-build -> invoke ->
response-handle boilerplate that was previously copy-pasted across every
*ClientImpl.Asset targeted by a cloud event (the Fabric v4
ResourceData schema).The drift verdict for one planned resource.
Abstract ResourceImpl class.
The kinds of element a deployment plan holds, in the order they are created.
Base class for minimal resource references that contain only a UUID identifier.
A registered resource type within the IAM access model, as returned by the IAM
resource-type operations.
The association between an action and a resource type, as returned by the IAM
resource-type-action operations.
Read-only JSON model for the IAM
ResourceTypeAction response.Token-paginated JSON model for the IAM
ResourceTypeActionPage response schema.Internal client for the IAM access-model discovery operations (resource types, actions, action
sets, resource-type actions, and service policy schemas).
Internal client implementation for the IAM access-model discovery operations.
Read-only JSON model for the IAM
ResourceType response.Token-paginated JSON model for the IAM
ResourceTypeList response schema.A small, generic poller for asynchronous Equinix resources: re-fetch a resource on an interval
until it reaches a desired state, fails, or a timeout elapses.
Maps an Equinix API error response (status code + headers + body) into the appropriate typed
EquinixServiceException.Deserializes and maps
EquinixResponse bodies: singleton/list/paginated JSON handling,
raw string/byte/map handling, header extraction, and the JSON-to-model mapping helpers that
turn deserialized Pages into user-facing PaginatedLists.Controls automatic retry of transient failures.
FindingCategory.RIGHT_SIZE_DOWN and FindingCategory.RIGHT_SIZE_UP: a live
connection whose 95th-percentile use is far below (or close to) its provisioned bandwidth.Aggregated risk assessment for the recommended deployment topology.
A single risk identified in the recommended deployment topology.
Severity levels for risk findings produced by the metro optimization engine.
A named set of role actions that can be granted to a principal, as returned by the IAM roles
catalog (
GET /v1/roles, operationId listRoles; and
GET /v1/projects/{projectId}/roles, operationId listRolesByProjectId).An assignment of a
Role to a principal within a scope, as returned by the IAM role
assignment operations (GET /v1/roleAssignments, operationId listRoleAssignments;
POST /v1/roleAssignments, operationId createRoleAssignment;
GET /v1/roleAssignments/{roleAssignmentId}, operationId getRoleAssignment).Internal client for IAM role assignments:
GET /v1/roleAssignments (operationId listRoleAssignments),
POST /v1/roleAssignments (operationId createRoleAssignment),
GET /v1/roleAssignments/{roleAssignmentId} (operationId getRoleAssignment) and
DELETE /v1/roleAssignments/{roleAssignmentId} (operationId deleteRoleAssignment).Internal client implementation for IAM role assignments.
Read-only JSON model for the IAM
RoleAssignment response.Token-paginated JSON model for the IAM
RoleAssignmentList response schema.Internal client for the IAM roles catalog:
GET /v1/roles (operationId listRoles) and
GET /v1/projects/{projectId}/roles (operationId listRolesByProjectId).Internal client implementation for the IAM roles catalog.
Read-only JSON model for the IAM
RoleDetails response.Token-paginated JSON model for the IAM
RoleList response schema.What a rollback removed and what it had to leave behind.
The attachment of a Fabric Route Aggregation to a connection (or as listed against a Cloud
Router).
Internal client for Fabric Route Aggregation attachments.
Internal client for Fabric Route Aggregation attachments.
Client interface for managing rules within an Equinix Fabric route aggregation.
Request body for creating route aggregation rules in bulk
(
POST /routeAggregations/{routeAggregationId}/routeAggregationRules/bulk).Values of the
type property of the Fabric v4 RouteAggregationRulesData schema.Client interface for managing Equinix Fabric route aggregations.
Route Collector
How much slower real Equinix Fabric round trips are than the straight-fibre physics floor, fitted
from the metro pairs Fabric actually measures, so that an unmeasured pair can be estimated
from distance with a factor the catalogue itself supports instead of a hard-coded guess.
One fitted factor.
One Fabric-measured metro pair.
Route filter actions.
The attachment of a Fabric Route Filter to a connection (or as listed against a Cloud Router).
Internal client for Fabric Route Filter attachments.
Internal client for Fabric Route Filter attachments.
Request body for attaching a Route Filter to a Fabric connection
(
PUT /fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}).Client interface for managing rules within an Equinix Fabric route filter.
Request body for creating route filter rules in bulk
(
POST /routeFilters/{routeFilterId}/routeFilterRules/bulk).Values of the
type property of the Fabric v4 RouteFilterRulesData schema.Client interface for managing Equinix Fabric route filters.
The connection a Fabric Cloud Router action was issued against.
Route-count summary returned on the
connection / router reference of a
Fabric Cloud Router action.The Fabric Cloud Router a router action was issued against.
Assembles a complete Fabric Cloud Router body from a
PlannedCloudRouter - name,
metro, package, the optional account/project references, and the mandatory notification
recipients - mirroring ConnectionBodies for connections.A single route table entry.
Internal client for searching read-only route table entries.
Internal client for searching read-only route table entries.
The connection a
RouteTableEntry was learned over.Customer-route allowance of an Equinix Internet Access (EIA) v1 routing configuration.
Per-IP-version (IPv4 / IPv6) allowances of an Equinix Internet Access (EIA) v1 routing
configuration.
Peering allowance of an Equinix Internet Access (EIA) v1 routing configuration.
Peer-subnet allowance of an Equinix Internet Access (EIA) v1 routing configuration.
Routing-protocol allowances of an Equinix Internet Access (EIA) v1 routing configuration.
Internal client for the Equinix Internet Access (EIA) v1 routing-configuration lookup:
GET /internetAccess/v1/routingProtocolConfigurations - the allowed routing-protocol
configurations for a given use case and redundancy.Internal client implementation for the Equinix Internet Access (EIA) v1 routing-configuration
lookup
GET /internetAccess/v1/routingProtocolConfigurations.Request body for creating routing protocols in bulk on a connection
(
POST /connections/{connectionId}/routingProtocols/bulk).An allowed routing-protocol configuration for an Equinix Internet Access (EIA) v1 service, as
returned by
GET /internetAccess/v1/routingProtocolConfigurations.Read-only JSON model for a
RoutingProtocolConfiguration returned by the Equinix Internet
Access (EIA) v1 lookup GET /internetAccess/v1/routingProtocolConfigurations.Parent connection reference on a routing protocol (the Fabric v4
RoutingProtocolConnection schema).IP Version 4 (IPv4) routing protocol request carrying the collection of customer routes.
IP Version 6 (IPv6) routing protocol request carrying the collection of customer routes.
Operational data for a routing protocol (the Fabric v4
RoutingProtocolOperation
schema) - carries the provisioning errors reported when a routing protocol FAILED.Routing protocol of an Equinix Internet Access (EIA) v2 service, as returned in the service read
model.
A customer route of a
RoutingProtocolReadModel.Addressing plan (
IpBlockAddressingPlans) echoed back on a provider-assigned IPv4
RoutingProtocolReadModel.RoutingIpBlock: the size of the requested subnet and its regulatory purpose.RIR justification question/answer pair (
IpBlockQuestions) echoed back on a
provider-assigned IPv4 RoutingProtocolReadModel.RoutingIpBlock.A peering of a
RoutingProtocolReadModel: the Equinix/customer peer IPs and VRRP state.A connection referenced by a
RoutingProtocolReadModel.Peering.Subnet used for a
RoutingProtocolReadModel.Peering.Provider-assigned IP block referenced by a PA
RoutingProtocolReadModel.CustomerRoute.IPv4 or IPv6 routing details: the customer routes and peerings of a
RoutingProtocolReadModel.RoutingProtocolRequest model.
Common base for the routing protocol nested in a
ServiceRequest.RoutingProtocolResponse model.
Client interface for managing routing protocols on Equinix Fabric connections.
Discriminator for the routing protocol nested in an EIA v2 service request.
Result of validating the subnets associated with the connections on a Fabric Cloud Router.
What a rule may use besides the inventory and utilisation: pricing, thresholds, and the time the
analysis treats as "now" (the snapshot's as-of time, so offline re-runs give the same result).
Typed
serviceDetails for a smart hands run-jumper-cable order
(runJumperCableRequest.serviceDetails in the smart hands v1 spec).Fluent calculator that estimates how much routing cloud egress over an Equinix
private interconnect saves versus the public internet.
Fluent configuration for a savings estimate, terminated by
SavingsCalculator.Builder.calculate().The result of a
SavingsCalculator run: the modelled monthly cost of
egressing data over the public internet versus over an Equinix-provided private
interconnect, the Equinix interconnect cost, and the resulting net savings and
break-even points.Cost over the horizon under a range of growth, from
GrowthPlanner.scenarios(double, double, GrowthPlanner.MonteCarlo): deterministic
low/base/high cases and, when requested, a seeded Monte Carlo with its distributions stated.One deterministic case.
A seeded Monte Carlo summary: re-running with the same seed and inputs gives the same figures.
Enumerates the failure scenarios of a
DesignGraph, deterministically.The pairwise scenarios and how many exist.
What a
FailureScenario takes away.What still works in one scenario, compared with the baseline.
A scheduled report definition in the Report Center (Reports v1
scheduledReport).JSON model for a Report Center
scheduledReport.JSON model for the scheduled reports response (
search-scheduled-report-response); the
scheduled reports are carried in the data array.Scheduling details for a smart hands order.
Request body for scheduling a report
(
POST /v1/reportCenter/reports/scheduler, reportRequest).Cross Connect Installation Schedule.
Schedule type.
Schedules of the Cross Connect.
Schedule Code.
Categories used to decompose a metro's composite score into
individually inspectable dimensions.
A single dimension of a metro's composite score.
A single search condition (property/operator/values) within a
SearchFilter
(SearchCondition in the spec).Request-side pagination (offset + limit) for a
SearchRequest
(SearchPagination in the spec).Typed request body for the system-alerts search POST endpoint (
SearchRequest in the
spec).A single sort condition (direction + property) within a
SearchRequest
(SearchSort in the spec).Technical contact details on a secure cabinet order (
ContactDetails schema).Best time to call a secure cabinet technical contact (
ContactAvailability schema of the
Secure Cabinet v1 API).Phone details for a secure cabinet technical contact (
Phone schema).Cabinet configuration on a secure cabinet order (
OrderItem schema).Request body for a secure cabinet order
(
POST /securecabinet/v1/orders, OrderCreateRequest).Client interface for ordering secure cabinets in the Equinix Customer Portal.
Customer billing account that owns a colocation space in the Equinix Internet Access (EIA) v1
product-availability lookups.
How firm the recommendation is.
Whether a constraint decides the answer.
The frontier option nearest the recommendation in normalised-score space.
The range of one objective's share of the total weight over which the recommendation stays the same,
the other weights keeping their proportions to each other.
Unit of measure for a sensor reading.
Attaches JSON request bodies: the payload is carried on the request as a
RequestBody and serialized to the wire by
RequestFactory at dispatch time (once per
attempt), honoring the request's content type and any Jackson
FilterProvider.The shared state a
ToolHandler executes against: the lazily-built SDK facades
(Fabric + design engines, Customer Portal, Network Edge, IBX SmartView), the environment,
the JSON mapper, and the single-process DesignStore of plans and optimization results.Builder for
ServerContext.Creates the live pricing adapter for a provider.
A named set of actions grouped within a service, as returned by the IAM
service-action-set operations.
Read-only JSON model for the IAM
ServiceActionSetNoErn response.Token-paginated JSON model for the IAM
ServiceActionSetNoErnList response schema.One of the three API aspects of a service action (IAM access v1 spec schema
ServiceAspect).Billing type of an Equinix Internet Access (EIA) v2 service.
EmgReceiver backed by the Azure Service Bus ServiceBusReceiverClient, the
transport of the Equinix Messaging Gateway (AMQP 1.0; production namespace
equinixemg.servicebus.windows.net per the AsyncAPI spec).A connection of an Equinix Internet Access (EIA) v2 service, as returned in the service read
model (the
ConnectionReadModel: uuid, href, type and A-side).A-side of a
ServiceConnection: the originating access-point type and service.Service referenced on the A-side of a
ServiceConnection.Whether an IBX or network maintenance/incident affects the customer's services
(
Body.Impact; introduced in EMG release R2024.1, replacing the generic "OUTAGE" wording).A metro in which a service profile is available (the
GET /serviceProfiles/{uuid}/metros
response entries).Order backing an Equinix Internet Access (EIA) v2 service, as returned in the service read model.
Optional order details (
ServiceOrder) nested in a ServiceRequest for an Equinix
Internet Access (EIA) v2 service create.Status of the order backing an Equinix Internet Access (EIA) v2 service.
Type of the order backing an Equinix Internet Access (EIA) v2 service.
The policy schema for a service, describing the structure of policies the service accepts,
as returned by the IAM service-policy-schema operation.
Read-only JSON model for the IAM
ServicePolicySchema response.Internet access service product breakdown of an Equinix Internet Access (EIA) v1 price entry.
Access point of an
ServicePrice.ASidePrice.A-side (subscriber) configuration of a
ServicePrice.ConnectionPrice.Connection breakdown of a
ServicePrice.Customer route of a
ServicePrice.RoutingProtocolIpBlock.Physical port detail of a
ServicePrice.PortPrice.Port associated with an
ServicePrice.AccessPointPrice.Customer-route IP block of a
ServicePrice.RoutingProtocolPrice IP family.Routing protocol breakdown of a
ServicePrice.A virtual-device access point on a service profile (the Fabric v4
ServiceProfileAccessPointVD schema): type is always VD.Result of accepting or rejecting a pending service profile update.
Request body for accepting or rejecting a pending service profile update
(
POST /serviceProfiles/{serviceProfileId}/actions).Internal client for Fabric Service Profiles.
Last-mile provisioning address requirement (the Fabric v4
ServiceProfileLastMileAddress schema).Last-mile configuration for an LMAAS service profile (the Fabric v4
ServiceProfileLastMileConfig schema).Delivery window range for a last-mile catalog (the Fabric v4
ServiceProfileLastMileDeliveryDateRange schema).Contact details for notifications related to last-mile provisioning and ordering
(the Fabric v4
ServiceProfileLastMileNotification schema).Last-mile offering details (the Fabric v4
ServiceProfileLastMileOffering
schema).Price range for a last-mile offering (the Fabric v4
ServiceProfileLastMilePriceRange schema).Last-mile provider catalog details (the Fabric v4
ServiceProfileLastMileProductCatalog schema).One candidate Fabric service profile for a given (provider, metro), carrying the bandwidth
capability the deployment wizard needs to pick a profile that can actually carry a connection's
speed.
Client interface for managing Equinix Fabric service profiles.
Purchase order attached to an Equinix Internet Access (EIA) v2 service order.
Attachment reference of a
ServicePurchaseOrder.Purchase order (
ServicePurchaseOrder) supplied in the order of an Equinix Internet
Access (EIA) v2 service create.Attachment reference of a
ServicePurchaseOrderRequest.Request body for creating an Equinix Internet Access (EIA) v2 service via
POST /internetAccess/v2/services.Request body for searching Equinix Internet Access (EIA) v2 services via
POST /internetAccess/v2/services/search.One equality expression (
AndQuery).The
filter object: an and group of expressions.Sort property for
POST /internetAccess/v2/services/search (sort query parameter).Lifecycle state of an Equinix Internet Access (EIA) v2 service.
The service token a connection side was built from (spec schema
ServiceToken,
referenced by ConnectionSide.serviceToken).Request body for a service token action (
POST /serviceTokens/{serviceTokenId}/actions),
for example resending the token email notification.Internal client for Fabric Service Tokens.
Spec schema
SimplifiedTokenNetwork (writable members).Spec schema
VirtualDeviceInterface.Spec schema
SimplifiedVirtualDevice (writable members; type enum: EDGE).Client interface for managing Equinix Fabric service tokens.
Topology of an Equinix Internet Access (EIA) v2 service.
Client interface for Network Edge setup and configuration operations.
How urgent an
EstateFinding is.Ship-to address details for an outbound shipment (
shipmentAddress in the shipments v2
spec).The carrier service delivering a shipment (
carrier in the shipments v2 spec and
carrierName in the shipments v1 spec).An IBX where the current user may place shipment orders, with the cages (and, when
requested with
detail=true, accounts and cabinets) the user has access to
(location in the shipments v1 spec).An account holding a cage within a permitted shipment location
(
account in the shipments v1 spec).A cabinet within a permitted shipment location (
cabinets item in the shipments v1 spec).A cage within a permitted shipment location, with its types and accounts
(
cage in the shipments v1 spec).Request body for scheduling an inbound or outbound shipment
(
POST /colocations/v2/orders/shipments, Shipment_Create).Result of submitting an inbound or outbound v1 shipment order
(
shipment-order-response in the shipments v1 spec).JSON model for the inbound/outbound v1 shipment order result
(
shipment-order-response in the shipments v1 spec).Purchase-order details on a v1 shipment order (
purchaseOrder in the shipments v1
spec).The amount of money the purchase order contains (
price in the shipments v1 spec).Client interface for scheduling equipment shipments in the Equinix Customer Portal.
How a v1 shipment moves in or out of the IBX: via a carrier service or carried by the
customer.
Typed
serviceDetails for a smart hands shipment-unpack order
(shipmentUnpackRequest.serviceDetails in the smart hands v1 spec).Request body for updating an inbound or outbound shipment order
(
PATCH /colocations/v2/orders/shipments/{orderId}, Shipment_Modify_request).The two endpoints ("sides") of an interconnection: the originating A-side and the
destination Z-side.
An Equinix Internet Access (EIA) signature policy, as returned by the v1 signature-policies lookup
(
GET /internetAccess/v1/signaturePolicies).Internal client for the Equinix Internet Access (EIA) v1 signature-policies lookup:
GET /internetAccess/v1/signaturePolicies.Internal client implementation for the Equinix Internet Access (EIA) v1 signature-policies lookup
GET /internetAccess/v1/signaturePolicies.Read-only JSON model for a
SignaturePolicy returned by the Equinix Internet Access (EIA)
v1 signature-policies lookup (GET /internetAccess/v1/signaturePolicies).The location a set of Equinix Internet Access (EIA) signature policies applies to.
The accepted signature methods of an Equinix Internet Access (EIA) signature policy.
The signature method permitted by an Equinix Internet Access (EIA) signature policy, as returned
by
GET /internetAccess/v1/signaturePolicies.The
location of an access point on a create request: {"metroCode": "SV"}.SimplifiedAccount model.
SimplifiedLocation model.
Configuration details for the port used at an access-point selector (spec schema
SimplifiedMetadataEntity).SimplifiedNotification model.
Notification Type
The Fabric network used at an access-point selector (spec schema
SimplifiedTokenNetwork).The Network Edge virtual device used at an access-point selector (spec schema
SimplifiedVirtualDevice)."simulated_resilience": the share of a portfolio's baseline service that survives its worst single-element
failure, 0 to 100, measured by building the design graph and simulating every metro, Cloud Router,
on-ramp and connection loss (
N1Survival).A place the design must serve: an office, a user population, a factory or an existing data
centre.
The business role of a user-defined site.
Response returned after submitting a smart hands order, carrying the generated order number.
An account associated with a cage in the smart hands location reference data.
Reference to an attachment uploaded via the Attachments API, to be attached to a
smart hands order.
A cabinet within an account in the smart hands location reference data.
A cage (or suite) within an IBX, including its types and the accounts it belongs to.
Who provides the camera for a smart hands pictures/document order (
cameraProvidedBy in
the smart hands v1 spec).Cable connector type for a smart hands run-jumper-cable or request-cables order
(
connectorType / connector in the smart hands v1 spec).Type of contact attached to a smart hands order.
A cross-connect entry for a smart hands patch-cable-install order
(
cross-connect-install in the smart hands v1 spec).A cross-connect entry for a smart hands patch-cable-removal order
(
cross-connect-removal in the smart hands v1 spec).A device referenced by a smart hands move-jumper-cable or run-jumper-cable order
(
device in the smart hands v1 spec).Jumper type for a smart hands run-jumper-cable order (
jumperType in the smart hands
v1 spec).An IBX and its cages where the current user is permitted to place smart hands orders.
Envelope for the smart hands locations reference endpoint, wrapping the list of locations.
Cable media type for a smart hands run-jumper-cable or request-cables order
(
mediaType in the smart hands v1 spec).Shared request body for all smart hands order types.
Client interface for submitting Smart Hands orders in the Equinix Customer Portal.
Scheduling option for a smart hands order.
The type of a Smart Hands order (
smarthandType.type in the Smart Hands v1 spec).Envelope for the smart hands types reference endpoint, wrapping the list of supported types.
Duration of the visit for a smart hands cage-escort order (
durationVisit in the smart
hands v1 spec).A supported smart hands order type, as returned by the reference types endpoint.
Client interface for the IBX SmartView Assets API.
Everything a
Solver needs.Searches the portfolios a
SolveProblem allows and returns the trade-off frontier and the
recommended option.A
DesignSolution plus the evidence behind it, kept so the answer can be interrogated without
searching again: every feasible portfolio with its raw objective values, and every portfolio that
failed exactly one constraint (grouped by that constraint).A portfolio and its raw objective values (NaN = unknown).
How the search went.
The inputs the TCO and savings models take, derived from a
DesignSpec (and optionally the
portfolio a run chose) the same way the optimiser's RateCardCostModel reads them, so the three
price the same thing.One problem found by
DesignSpec.validate().How serious a
SpecIssue is.Estimates network latency from geographic distance using the speed of light in optical fiber.
Fluent configuration for
SpeedOfLightLatency.Whether to report a one-way or a round-trip (RTT) figure.
A
BearerTokenProvider that always returns one fixed BearerToken.STATIC routing protocol nested in a ServiceRequest.The
status envelope returned alongside the payLoad of most legacy
(v1) IBX SmartView responses.What execution or reconcile did with one plan step.
The result of one plan step in an execution or reconcile run.
A metric alert rule attached to a Fabric stream.
Fluent builder/updater for Fabric stream alert rules.
Client interface for managing alert rules attached to Equinix Fabric streams.
Values of the
state property of the Fabric v4 StreamAlertRule schema.Values of the
type property of the Fabric v4 StreamAlertRule schema.An asset (port, connection, router, etc.) attached to a Fabric stream for telemetry.
Values of the
attachmentStatus property of the Fabric v4 StreamAsset schema.Internal client for Fabric Stream Assets (attach / detach / get an asset to/from a stream).
Request body for attaching an asset to a Fabric stream
(
PUT /streams/{streamId}/{asset}/{assetId}).Client interface for attaching and detaching assets (ports, connections, routers, etc.) to and
from Equinix Fabric streams for telemetry.
Values of the
type property of the Fabric v4 StreamAsset schema.A Network Edge device interface attached to a stream, as returned by
/fabric/v4/streams/{streamId}/devices/{deviceId} (spec 4.34.0 example
StreamDeviceAssetResponse).Body of
PUT /fabric/v4/streams/{streamId}/devices/{deviceId} (spec
StreamDevicePutRequest): the complete desired set of device interfaces to stream.Interface reference:
{"id": 3}.A single stream subscription filter expression (spec schema
StreamFilter, an anyOf of
StreamFilterSimpleExpression and StreamFilterOrFilter).A streaming subscription (
SubscriptionResponse in the spec).Typed request body for creating/updating a streaming subscription
(
SubscriptionRequest in the spec).Client interface for managing IBX SmartView streaming subscriptions.
Client interface for managing Equinix Fabric event streams.
Stream subscription sink settings (e.g.
Filters applied to a stream subscription (spec schema
StreamSubscriptionFilter):
a conjunction of up to 8 StreamFilter expressions.Operational information for a stream subscription (the Fabric v4
StreamSubscriptionOperation schema): delivery counters, last successful
delivery time, suspension time and delivery errors.External error information from a stream subscription sink (the Fabric v4
StreamSubscriptionOperationAdditionalInfo schema).Error information for stream subscription delivery (the Fabric v4
StreamSubscriptionOperationErrors schema).Client interface for managing subscriptions to Equinix Fabric event streams.
Event or metric selector for a stream subscription, expressed as include/except
expression lists (e.g.
Values of the
type property of the Fabric v4 StreamSubscriptionSinkCredential schema.Webhook message format (the Fabric v4
StreamSubscriptionSinkSetting.format attribute:
CLOUDEVENT or OPENTELEMETRY; the API default is CLOUDEVENT).The primary entry point for accessing the Equinix Security Token Service (STS) API (STS v1).
Client interface for the STS unauthenticated discovery endpoints.
Client interface for managing trusted OIDC providers within a root project
(
/v1/projects/{projectId}/oidcProviders).Typed values for the STS token-exchange
scope (TokenRequest.scope(StsScope)).A security token issued by the Equinix Security Token Service, as returned by the STS token
exchange operation.
Read-only JSON model for the STS
TokenResponse.Client interface for the STS pre-auth token operations.
Sub-channel used to place an order (Orders v2 / Billing v2 APIs - the union of both specs'
values).
Sub-interface information of a port link protocol (the Fabric v4
SubInterface schema).The asset covered by a marketplace subscription entitlement (the Fabric v4
SubscriptionAsset schema).The certificate used to authenticate a streaming channel
(
SubscriptionCertificateResponse in the spec).Near real-time subscription data retrieved via REST (
SubscriptionData in the spec).An entitlement associated with a marketplace subscription (the Fabric v4
SubscriptionEntitlementResponse schema): the entitled/consumed/available quantities
and the asset they apply to.The Cloud Router package of a marketplace subscription asset (the Fabric v4
SubscriptionRouterPackageType schema).Lifecycle status of a streaming subscription.
Free-trial details of a marketplace subscription (the Fabric v4
SubscriptionTrial
schema).A
BearerTokenProvider that obtains every token from a Supplier.A trouble ticket / support case retrieved by case or order number from the Equinix Customer
Portal support v2 API (
SingleCaseResponseV2).Reference to a previously uploaded attachment (
Attachment) on a support case create or
note request.A file attached to a support case (
Attachment).Request body for cancelling a trouble ticket / case.
A contact associated with a support case (
ContactResponse).A single communications detail of a support case contact.
Request body for creating a trouble ticket / support case.
A line-item detail of a support case
(
SingleCaseResponseV2.otherDetails.details).An email conversation attached to a support case (
Email).Estimated completion of a support-case line item
(
SingleCaseResponseV2.otherDetails.details[].estimatedCompletion).A support case retrieved by case or order number from the Equinix Customer Portal support v2 API
(
SingleCaseResponseV2).The IBX location(s) associated with a support case (
SingleCaseResponseV2.location).A note recorded against a support case.
Request body for adding a note to an existing trouble ticket / case.
The type of a support-case note (
SingleCaseResponseV2.notes[].type in the Support v2 spec).Additional details of a support case (
SingleCaseResponseV2.otherDetails), carrying the
case category, its line-item details and status history, and the actions currently permitted on
the case (modifiable, reOpen, cancellable, respond).The record type of a support case (
SingleCaseResponseV2.otherDetails.recordType in the
Support v2 spec).Client interface for raising and managing trouble tickets / support cases in the Equinix
Customer Portal.
The status of a support case / trouble ticket (support v2 API,
StatusResponse).A status transition recorded against a support case
(
SingleCaseResponseV2.otherDetails.statusHistory).A Smart Hands support plan retrieved from the Equinix Customer Portal Support Plans v2 API
(
GET /colocations/v2/supportPlans).Customer assignment details for a support plan.
Assignment status of a Smart Hands support plan assigned by a reseller to an end customer.
JSON model for a Smart Hands support plan (
supports schema, Support Plans v2 API).Client interface for accessing Smart Hands support plans in the Equinix Customer Portal.
Lifecycle status of a Smart Hands support plan.
Contributes the
CarbonObjective ("carbon").A system alert raised by a monitored asset (
AlertReadModel in the spec).Client interface for querying IBX SmartView system alerts.
A Fabric resource tag (used to categorize company profiles and other resources).
Internal client for Fabric resource tags.
Request body for creating a Fabric resource tag (
POST /tags).Identifies the monitoring tag associated with a
TagPoint reading.Response wrapper for
GET /fabric/v4/companyProfiles/{companyProfileId}/tags, which returns
a non-paginated { "data": [...] } envelope of Tag entries.A streaming reading for a single monitoring tag point within an IBX, including the
measured value with its unit.
Current tag-point data for one or more tag identifiers, wrapped in the
payLoad/status envelope returned by the asset tag-point endpoints
(TagPointData in the spec).A single tag point reading element, including alarm status, returned within asset details.
A single current tag point reading element returned by the asset tag point endpoints.
Deserialization holder for the asset/tagpoint/current response, wrapping the current
tag point readings (
payLoad) and the shared status envelope.The streaming envelope wrapping a
TagPoint payload, carrying the message type
and its data.A measured value paired with its unit, as reported by a
TagPoint reading.Equinix Fabric Tag Response Object
Status of the Tag request.
Fabric tags (single-tag lookup) (1 operations).
Client interface for managing Equinix Fabric resource tags.
Implementation of
Tags over the shared FabricBeta apiParams area.Fluent calculator that compares the total cost of ownership of a workload across
the
DeploymentArchetypes - public cloud over the internet, on-prem,
Equinix-interconnected, and (for a cloud-to-cloud comparison) the providers' native
multicloud link - and reports which is cheapest over the commitment
term (monthly recurring × term months + one-time setup) and by how much.Fluent configuration for a TCO comparison, terminated by
TcoCalculator.Builder.compare().The result of a
TcoCalculator run: a side-by-side cost comparison of the
requested DeploymentArchetypes, the recommended approach - the lowest
total cost over the commitment term (MRC × months + NRC), so
one-time setup charges count - and the saving of the recommended approach versus
the public-cloud-over-internet baseline, both per month and over the term.A template within an asset-list category, grouping a set of assets.
Commitment term for a priced resource.
The account a set of Equinix Internet Access (EIA) terms and conditions applies to.
A set of Equinix Internet Access (EIA) terms and conditions, as returned by the v1 terms lookup
(
GET /internetAccess/v1/terms).Read-only JSON model for
TermsAndConditions returned by the Equinix Internet Access (EIA)
v1 terms lookup (GET /internetAccess/v1/terms).Internal client for the Equinix Internet Access (EIA) v1 terms-and-conditions lookup:
GET /internetAccess/v1/terms.Internal client implementation for the Equinix Internet Access (EIA) v1 terms-and-conditions
lookup
GET /internetAccess/v1/terms.The connectivity source a set of Equinix Internet Access (EIA) terms and conditions applies to.
A terms-of-use entry on an invoice line item (Billing v2 API).
Period type of a terms-of-use entry on an invoice line item (Billing v2 API; the Quotes v2
termsOfUse_Details.period adds DAYS).Type of a terms-of-use period on an invoice line item (Billing v2 API; the Quotes v2
termsOfUse_Details.type adds NON_RENEWAL_NOTICE).The Equinix product a set of terms and conditions applies to, as used by the Equinix Internet
Access (EIA) v1 terms lookup (
GET /internetAccess/v1/terms).The category of terms and conditions returned by the Equinix Internet Access (EIA) v1
terms lookup (
GET /internetAccess/v1/terms).Renders a
DeploymentPlan produced by the Deployment Wizard into
Infrastructure-as-Code (HCL) for the
Equinix Terraform provider.A file attached to a trouble ticket or ticket note (
Attachment).Body of an IBX (data center) or network maintenance/incident notification.
An affected customer asset.
Request body for cancelling a trouble ticket
(
POST /v2/tickets/{id}/cancel, Tickets_Cancel).The kind of event an IBX or network ticket notification describes, derived from the suffix of
Task.Resource (for example DataCenter.Maintenance or Network.Incident).Trouble ticket problem code (
Tickets_Create.code in the tickets v2 spec).A contact associated with a trouble ticket (
Contacts).A single communications detail of a trouble ticket contact (
ContactsDetails).A note recorded against a trouble ticket (
Note).Request body for adding a note to a trouble ticket
(
POST /v2/tickets/{id}/notes, NoteRequest).The type of a trouble-ticket note (
Note.type in the Tickets v2 spec).A resolution event recorded against a trouble ticket (
Resolutions).Response body returned when a support case / trouble ticket is created via the support v2 API
(
TicketResponse).Lifecycle state of an IBX or network maintenance/incident ticket (
Body.State).The current status of a trouble ticket (Tickets v2 API).
The type of a created ticket (
TicketResponse.type in the Support v2 spec).Request body for updating a trouble ticket
(
PATCH /v2/tickets/{id}, Tickets_Modify).An L2 connection link associated with a Precision Time (EPT) service instance.
Request body for fulfilling (provisioning) a Precision Time service via
PUT /timeServices/{serviceId} (spec schema precisionTimeServiceRequest).Reference to a Fabric connection, identified by UUID.
Operational data for a Precision Time service (the Fabric v4
timeServiceOperation
schema).Values of the
operationalStatus property of the Fabric v4 timeServiceOperation schema.A Precision Time (EPT) service package and its capabilities.
Values of the
type property of the Fabric v4 precisionTimePackageResponse schema.Precision Time product configuration of a price row (the Fabric v4
TimeServicePrice
schema): protocol type, package and the connection access point the price applies to
(TimeServicePriceConnection / TimeServicePriceConnectionASide /
TimeServicePriceConnectionAccessPoint).Access point of the Time Service price connection (the
TimeServicePriceConnectionAccessPoint schema).A-side of the Time Service price connection (the
TimeServicePriceConnectionASide
schema).Time Service price connection configuration (the
TimeServicePriceConnection schema).Internal client for the STS pre-auth token operations:
POST /v1/token (operationId generateStsToken) - the OAuth 2.0 / RFC 8693
token exchange (consumes application/x-www-form-urlencoded) - and
POST /v1/accessPoliciesGranted (operationId listAccessPoliciesGranted).Internal client implementation for the STS pre-auth token operations.
An OAuth 2.0 token-exchange request body (RFC 8693) for
POST /v1/token (operationId
generateStsToken, spec schema TokenRequest).OAuth 2.0 token type of an issued STS token (STS v1 spec schema
TokenResponse, property
tokenType).Thrown by a handler that stops because the client cancelled its tool call with
notifications/cancelled.The body of an MCP tool: takes the parsed argument JSON and the shared
ServerContext, returns the structured result payload.A handler that observes its cancellation signal while it runs.
One complete MCP tool definition: name, description, JSON input/output schema, behavior
annotations, owning
Toolset, and the ToolHandler that executes it.The named tool groups the embedded MCP server can expose, selectable via
EquinixMcpServer.builder().toolsets(...), the EQUINIX_MCP_TOOLSETS
environment variable, or the --toolsets launch argument (comma-separated ids,
e.g.Renders deployment topologies as Mermaid
graph text.Trending environmental (temperature or humidity) time-series data for a hierarchy node,
wrapped in the
payLoad envelope returned by the legacy
/environment/v1/trending endpoint.The
payLoad of a TrendingEnvironmentData response.Trending power consumption time-series data for a hierarchy node, wrapped in the
payLoad/status envelope returned by the legacy /power/v1/trending
endpoint.The
payLoad of a TrendingPowerData response.A trouble ticket retrieved from the Equinix Customer Portal Tickets v2 API.
A contact on a trouble ticket order (
contactInfo).Request body for creating a trouble ticket
(
POST /v2/tickets, Tickets_Create).A trouble ticket as returned by the Tickets v2 API (
Tickets).Envelope for the trouble ticket locations reference endpoint, wrapping the list of permitted
IBX/cage locations.
An account associated with a cage where the current user may place trouble ticket orders
(
account).A cabinet within a trouble ticket order account (
cabinets).A cage (or suite) where the current user may place trouble ticket orders (
cage), along
with its cage types and accounts.An IBX and its cages where the current user is permitted to place trouble ticket orders.
Request body for placing a trouble ticket order (
POST /v1/orders/troubleticket,
TroubleTicketOrderRequest).Raw result body of a placed trouble ticket order.
Client interface for submitting trouble tickets in the Equinix Customer Portal.
Client interface for managing trouble tickets in the Equinix Customer Portal.
Trouble-related information for a trouble ticket order (
serviceDetails).A trouble ticket problem category, as returned by the reference types endpoint.
Additional detail of a trouble ticket type (
troubleTicketType.additionalDetails),
carrying the sub-categories and the IBXs the type is enabled for.Envelope for the trouble ticket types reference endpoint, wrapping the list of supported types.
Unified view of all connectivity options to a target ASN across Equinix metros,
combining both IX peering (from PeeringDB) and Fabric private connections
(from Equinix Fabric service profiles).
A single metro's connectivity details for this ASN.
A unified order / colocation notification event returned by the Customer Portal unified
notifications v2 search API.
Client interface for searching unified order and colocation notifications in the Equinix
Customer Portal.
Search criteria body for the unified notifications search endpoint
(
POST /notifications/v2/events/findAll).Filter criteria for a unified notifications search.
Pagination request information for a unified notifications search.
A single sort criterion for a unified notifications search.
Envelope for the unified notifications search endpoint, wrapping the
data list of
notification events.Unit of measure for a quote line item (
quote_details.unitOfMeasure in the Quotes v2 spec).A well-formed EMG envelope this SDK version cannot type: an unrecognised
Task.Resource,
a missing Body, or a body that does not fit the model for its resource.A live resource that carries the plan's marker (its deployment name in
additionalInfo, or the
plan's name prefix) but matches no planned resource: left over from an earlier version of the plan,
or created by hand.The one place tool output handles text that came from a remote system: Equinix API fields
(ticket references, device names, service-profile names, error messages), PeeringDB names, and
the messages of failed pricing lookups.
A text node holding sanitised remote text.
Request body for updating an IAM access policy via
PUT
/v1/projects/{projectId}/accessPolicies/{accessPolicyId} (operationId updateAccessPolicy,
spec schema UpdateAccessPolicyBody).Request body for updating an IAM permission set via
PUT
/v1/projects/{projectId}/permissionSets/{permissionSetId} (operationId
updatePermissionSet, spec schema UpdatePermissionSetBody).Request body for updating an IAM policy mask via
PUT
/v1/projects/{projectId}/policyMasks/{policyMaskId} (operationId updatePolicyMask, spec
schema UpdatePolicyMaskBody).Request body for updating an IAM principal policy via
PUT
/v1/projects/{projectId}/principalPolicies/{principalId} (operationId
updatePrincipalPolicy, spec schema UpdatePrincipalPolicyBody).UpgradeStatus class.
Intended use case of an Equinix Internet Access (EIA) v2 service.
Details of a port currently in use on a patch panel (Customer Portal Lookup v2 API).
A user-defined location representing a workforce concentration, customer market,
or operational site.
Reads bandwidth utilisation for the live connections (and optionally the active ports) of an
inventory through
POST /fabric/v4/metrics/search and reduces it to p50 / p95 / peak.Configures a probe.
Fetches the metrics of one search.
Pauses between requests (replaceable in tests).
Bandwidth utilisation of the resources in an estate over one time window, reduced to
percentiles.
Utilisation of one resource.
Read-only JSON model for a single
ValidateConnectionResult entry returned by the
connection validation API.A single connection specification returned by the Fabric connection validation API
(
POST /fabric/v4/connections/validate).The tag-reading values associated with a system alert (
ValueReadModel in the spec).How an objective's raw value becomes a 0..100 score (100 = best) for the weighted ranking.
Linear between two fixed anchors, clamped.
The value is a percentage: it is the score when larger is better, and 100 minus it otherwise.
Min-max over the options being ranked.
The ratio to the best value: an option 7% dearer than the cheapest scores about 93, one twice as
dear scores 50.
Network Edge device vendor (
VirtualDeviceType.vendor, display form, and
VirtualDeviceDetailsResponse.deviceTypeVendor, code form).Vendor-specific device management type (spec
VendorConfig.managementType) - how a Fortinet/Cisco
FTD-style device is managed.The outcome of one scenario, compared with the baseline (no failure).
Verification state of a specification connection (
common.yaml#/VerificationState);
carried by Connection.verificationState, output only.An allowed virtual-bandwidth configuration for an Equinix Internet Access (EIA) v1 service, as
returned by
GET /internetAccess/v1/virtualBandwidthConfigurations.Internal client for the Equinix Internet Access (EIA) v1 virtual-bandwidth-configuration lookup:
GET /internetAccess/v1/virtualBandwidthConfigurations - the allowed virtual-bandwidth
configurations for a given use case and billing model.Internal client implementation for the Equinix Internet Access (EIA) v1
virtual-bandwidth-configuration lookup
GET /internetAccess/v1/virtualBandwidthConfigurations.Read-only JSON model for a
VirtualBandwidthConfiguration returned by the Equinix Internet
Access (EIA) v1 lookup GET /internetAccess/v1/virtualBandwidthConfigurations.Connection A-side access point of an Equinix Internet Access (EIA) v1 virtual-connection default
configuration.
Connection A-side of an Equinix Internet Access (EIA) v1 virtual-connection default configuration.
Connection allowance of an Equinix Internet Access (EIA) v1 virtual-connection default
configuration.
Customer-route allowance of an Equinix Internet Access (EIA) v1 virtual-connection default
configuration.
A default virtual-connection configuration for an Equinix Internet Access (EIA) v1 service, as
returned by
GET /internetAccess/v1/virtualConnectionDefaultConfigurations.Internal client for the Equinix Internet Access (EIA) v1 virtual-connection default-configuration
lookup:
GET /internetAccess/v1/virtualConnectionDefaultConfigurations - the default
virtual-connection configurations for a given IBX and metro.Internal client implementation for the Equinix Internet Access (EIA) v1 virtual-connection
default-configuration lookup
GET /internetAccess/v1/virtualConnectionDefaultConfigurations.Read-only JSON model for a
VirtualConnectionDefaultConfiguration returned by the Equinix
Internet Access (EIA) v1 lookup
GET /internetAccess/v1/virtualConnectionDefaultConfigurations.Connection A-side location of an Equinix Internet Access (EIA) v1 virtual-connection default
configuration.
Routing-protocol allowances of an Equinix Internet Access (EIA) v1 virtual-connection default
configuration.
Per-IP-version (IPv4 / IPv6) routing allowances of an Equinix Internet Access (EIA) v1
virtual-connection default configuration.
A virtual device associated with an ACL template (
VirtualDeviceACLDetails in the
Network Edge API spec), returned in ACLTemplateDetailsResponse.virtualDeviceDetails.Virtual device type (Fabric v4
SimplifiedVirtualDevice / VirtualDevice schemas).Virtual Network reference for use as an access-point target.
Port configuration (the Fabric v4
VirtualPortConfiguration schema): buyout
(true) or standard (false) configuration of the port.Virtual port package (the Fabric v4
VirtualPortPackage schema).Redundant-connection preferences for a virtual port (the Fabric v4
VirtualPortRedundancy schema).Client interface for managing VPN configurations on Network Edge devices.
Status of a Network Edge VPN.
Base type for failures raised by
ResourceWaiter.Thrown by
ResourceWaiter.await() when the resource reaches a terminal failure state
(the configured failWhen condition) before succeeding.Thrown by
ResourceWaiter.await() when the success condition is not met before the
configured timeout elapses.Configuration for a
WEBHOOK streaming channel.Named starting points for objective weights.
The estimated availability of one workload, composed from
AvailabilityAssumptions over the
graph's redundant paths.Something that runs and needs connectivity.
Each workload with a
maxLatencyMs must be placed (by WorkloadPlacer) in a metro whose
worst known round trip to any site is within the limit.What happens to one workload in one scenario.
Assignment of a single workload to a specific metro with placement rationale.
Places every workload of a spec on a portfolio.
Defines the infrastructure characteristics of a workload type.
Defines a workload to be placed by the optimizer, including its type,
infrastructure requirements, and provider dependencies.
How one workload fares in a scenario.
Pre-defined workload archetypes with built-in infrastructure profiles.
A cage scheduled for a work visit (
Cages_details in the work-visits v2 spec).Details for scheduling a work visit (
details of Workvisit_Create in the
work-visits v2 spec, the allOf of cages plus workvisit_additional_details).Request body for scheduling a work visit
(
POST /colocations/v2/orders/workVisits, Workvisit_Create).Client interface for scheduling work visits in the Equinix Customer Portal.
Details for updating a work visit (
workvisits_additional_info in the work-visits v2
spec).Request body for updating a work visit order
(
PATCH /colocations/v2/orders/workVisits/{orderId}, Modify_request).A work-visit visitor (
anyOf RegisteredUser / NonRegisteredUser_Visitor
in the work-visits v2 spec).A contact detail for a non-registered visitor
(
VisitorContactsRequestDetails in the work-visits v2 spec).Communications type of the contact value.