Equinix Connections API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Connections. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 7 operations across 5 paths, and defines 128 schemas. It is described by OpenAPI 3.0.1, at version 1.2.
Requests are made against a single base URL, https://api.equinix.com.
7 operations
5 paths
128 schemas
1 DELETE1 GET1 PATCH4 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 7
Across 5 paths, the API surfaces 7 operations — 1 DELETE, 1 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Connections 7
Connections
POST
/fabric/v4/connections
Create Connection
GET
/fabric/v4/connections/{connectionId}
Get Connection by ID
DELETE
/fabric/v4/connections/{connectionId}
Delete by ID
PATCH
/fabric/v4/connections/{connectionId}
Update by ID
POST
/fabric/v4/connections/{connectionId}/actions
Connection Actions
POST
/fabric/v4/connections/search
Search connections
POST
/fabric/v4/connections/validate
Validate Connection
Schemas 128
The contract defines 128 schemas that model the data the API accepts and returns. The most detailed are SimplifiedPort (30 properties), Connection (21 properties), ServiceProfileMetadata (19 properties), SimplifiedServiceProfile (17 properties). Each schema is shown below with its type and property counts.
NetworkEquinixStatus
string
Network status
SearchRequest
object
Search requests containing criteria
3 properties
Change
object
Current state of latest connection change
7 properties
2 required
PortState
string
Port lifecycle state
SortCriteria
object
2 properties
ConnectionAction
object
Connection action
6 properties
4 required
PortPriority
string
Port priority in redundancy group
CloudRouterPostRequestPackage
object
Fabric Cloud Router Package Type
3 properties
1 required
PeeringType
string
Access point peering type
ServiceProfileLinkProtocolConfig
object
Configuration for dot1q to qinq translation support
5 properties
ConnectionPriority
string
Connection priority in redundancy group
VirtualDeviceInterface
object
Virtual Device Interface Information
3 properties
ServiceProfileMetadata
object
Metadata. Response attribute. Ignored on request payload.
19 properties
ServiceProfileVisibilityEnum
string
ConnectionResponse
object
ValidateResponse
2 properties
VirtualCircuitId
string
Virtual Circuit UUID
ConnectionUpdateRequest
array
Connection Update Request
PortAdditionalInfo
object
Additional information
2 properties
ServiceProfileAccessPointTypeEnum
string
Access point type
Pagination
object
Pagination response information
5 properties
2 required
CloudRouterChangeOperation
object
Fabric Cloud Router change operation data
3 properties
3 required
ConnectionId
string
Connection UUID
SimplifiedServiceProfile
object
Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information…
17 properties
ConnectionSide
object
Connection configuration object for each side of multi-segment connection
3 properties
Actions
string
Connection action type
ServiceProfileAccessPointTypeCOLO
object
Colo Access Point Type
16 properties
1 required
ErrorList
array
List of Error Message
PortDeviceRedundancy
object
Device redundancy
2 properties
PortRedundancy
object
Port redundancy configuration
3 properties
SimplifiedLocationWithoutIBX
object
4 properties
1 required
ServiceTokenConnection
object
Service Token Connection Type Information
9 properties
PortDemarcationPoint
object
Customer physical Port
8 properties
ServiceTokenState
string
Service token state
AccessPointType
string
Access point type
Expression
object
5 properties
ValidateRequest
object
Validate connection auth api key or vlan
1 property
Expressions
array
PortType
string
Type of Port
ValidateRequest_filter_and
object
3 properties
PhysicalPort
object
Physical Port specification
17 properties
ConnectionSideAdditionalInfo
object
Additional information
2 properties
ProviderStatus
string
Connection provider readiness status
SimplifiedLocation
object
5 properties
PhysicalPortSettings
object
Physical Port configuration settings
2 properties
SortCriteriaResponse
object
2 properties
PortOrder
object
6 properties
SortDirection
string
Sorting direction
CloudRouterChange
object
Current state of latest CloudRouter change
7 properties
2 required
PriceError_additionalInfo
object
2 properties
ServiceTokenSide
object
Connection link protocol,virtual device or network configuration
1 property
Project
object
1 property
1 required
PortOrderPurchaseOrder
object
purchase order
7 properties
Package
object
Package settings for port
2 properties
GeoScopeType
string
Geographic boundary types
SimplifiedNetworkChange
object
Current state of latest network change
3 properties
ValidateRequest_filter
object
Filters
1 property
ConnectionSearchResponse
object
List of connections
3 properties
AccessPointSelector
object
List of criteria for selecting network access points with optimal efficiency, security, compatibility, and availability.
7 properties
Interface
object
Interface Information
5 properties
ServiceProfileTypeEnum
string
Service profile type
PortInterface
object
Port interface
1 property
ApiConfig
object
Configuration for API based Integration for Service Profile
7 properties
LinkProtocolType
string
Type of Link Protocol
NetworkType
string
Network type
ConnectionChangeOperation
object
Connection change operation data
3 properties
3 required
PhysicalPortType
string
Type of Port
NetworkChangeType
string
Type of change
PortEncapsulation
object
Port encapsulation configuration
2 properties
ServiceToken
object
Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove…
14 properties
Changelog
object
Change log
12 properties
PortSettings
object
Port configuration settings
7 properties
ServiceProfileAccessPointVD
object
Virtual Device Point
4 properties
2 required
ConnectionRedundancy
object
Connection redundancy configuration
2 properties
ConnectionAcceptanceData
object
Connection acceptance data
2 properties
marketplaceSubscription
object
Equinix Fabric Entity for Marketplace Subscription
3 properties
PortTether
object
Port physical connection
7 properties
CloudRouter
object
Fabric Cloud Router object
9 properties
Tags
array
ConnectionDirection
string
Connection directionality from the requester point of view
Link
object
5 properties
NetworkOperation
object
Network operational data
1 property
SimplifiedNetwork
object
Network specification
12 properties
1 required
ValidateConnectionResponse
object
Validate Connection specification
5 properties
SearchFieldName
string
Possible field names to use on filters
VirtualNetwork
object
Virtual Network Information
2 properties
ServiceProfileAccessPointType
object
Access Point Type
ConnectionOperation
object
Connection type-specific operational data
5 properties
MarketingInfo
object
3 properties
PortOrderSignature
object
Port signature details
2 properties
SimplifiedAccount
object
12 properties
CloudRouterPostRequestBase
object
Create Cloud Router
9 properties
Error
object
Error Response with details
6 properties
2 required
SimplifiedTokenNetwork
object
6 properties
Bandwidths
array
VirtualDevice
object
Virtual Device AccessPoint Information
6 properties
PortServiceCode
string
type of product
SortBy
string
Possible field names to use on sorting
AccessPoint
object
Access point object
17 properties
Connection
object
Connection specification
21 properties
5 required
ProcessStep
object
Definition of customized step while making connection
3 properties
EquinixStatus
string
Connection status
ConnectionActionRequest
object
Connection action request
3 properties
1 required
EndCustomer
object
3 properties
ServiceProfileAccessPointTypeVD
object
VirtualDevice Access Point Type
5 properties
1 required
NetworkState
string
Network status
SimplifiedMetadataEntity
object
Configuration details for port used at the access point.
10 properties
PaginationRequest
object
Pagination request information
2 properties
ServiceMetro
object
7 properties
PortOperation
object
Operational specifications for ports.
6 properties
SimplifiedVirtualDevice
object
6 properties
ServiceTokenType
string
Type of Service Token
SimplifiedNotification
object
4 properties
2 required
Bandwidth
integer
speed in Mbps
NetworkScope
string
Network scope
PortLoa
object
Port Loas
2 properties
PortDevice
object
Port device
3 properties
ServiceProfileAccessPointCOLO
object
Colo Access Point
6 properties
2 required
SimplifiedLinkProtocol
object
Connection link protocol Configuration
4 properties
PortOrderSignatureDelegate
object
order delegate details
3 properties
CustomField
object
Define Custom Attributes
6 properties
3 required
ConnectionType
string
Connection type
MetalInterconnection
object
Metal Interconnection
1 property
CloudRouterAccessPointState
string
Access point lifecycle state
ConnectionPostRequest
object
Create connection post request
13 properties
6 required
Order
object
7 properties
PortNotification
object
2 properties
2 required
SimplifiedPort
object
Port specification
30 properties
AuthenticationKey
object
Authentication Key Support and Customization
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Equinix 12
Other APIs Equinix publishes across the network.
Equinix Agent Templates API
Equinix Agents API
Equinix Authentication API
Equinix availability API
Equinix Batches API
Equinix BGP API
Equinix Capacity API
Equinix Cloud Events API
Equinix Cloud Routers API
Equinix Company Profiles API
Equinix Console Log Details API
Equinix Devices API
#Connections