Equinix Networks API
The Networks API from Equinix — 6 operation(s) for networks.
Equinix Networks API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Networks. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 8 operations across 6 paths, and defines 126 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.
8 operations
6 paths
126 schemas
1 DELETE4 GET1 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 8
Across 6 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Networks 8
POST
/fabric/v4/networks
Create Network
GET
/fabric/v4/networks/{networkId}
Get Network By ID
DELETE
/fabric/v4/networks/{networkId}
Delete Network By ID
PATCH
/fabric/v4/networks/{networkId}
Update Network By ID
POST
/fabric/v4/networks/search
Search Network
GET
/fabric/v4/networks/{networkId}/connections
Get Connections
GET
/fabric/v4/networks/{networkId}/changes
Get Network Changes
GET
/fabric/v4/networks/{networkId}/changes/{changeId}
Get Change By ID
Schemas 126
The contract defines 126 schemas that model the data the API accepts and returns. The most detailed are SimplifiedPort (30 properties), Connection (21 properties), ServiceProfileMetadata (19 properties), AccessPoint (17 properties). Each schema is shown below with its type and property counts.
GeoScopeType
string
Geographic boundary types
NetworkEquinixStatus
string
Network status
Bandwidths
array
ServiceTokenState
string
Service token state
NetworkSortByResponse
string
Possible field names to use on sorting
SimplifiedNetworkChange
object
Current state of latest network change
3 properties
AccessPointType
string
Access point type
PortServiceCode
string
type of product
VirtualDevice
object
Virtual Device AccessPoint Information
6 properties
AccessPoint
object
Access point object
17 properties
Connection
object
Connection specification
21 properties
5 required
AccessPointSelector
object
List of criteria for selecting network access points with optimal efficiency, security, compatibility, and availability.
7 properties
Change
object
Current state of latest connection change
7 properties
2 required
PortState
string
Port lifecycle state
Interface
object
Interface Information
5 properties
ProcessStep
object
Definition of customized step while making connection
3 properties
PortPriority
string
Port priority in redundancy group
CloudRouterPostRequestPackage
object
Fabric Cloud Router Package Type
3 properties
1 required
ServiceProfileTypeEnum
string
Service profile type
EquinixStatus
string
Connection status
NetworkChangeOperation
object
Network change operation data
3 properties
3 required
PortInterface
object
Port interface
1 property
NetworkFilter
object
5 properties
ApiConfig
object
Configuration for API based Integration for Service Profile
7 properties
PeeringType
string
Access point peering type
NetworkSortDirection
string
Sorting direction
LinkProtocolType
string
Type of Link Protocol
ServiceProfileAccessPointTypeVD
object
VirtualDevice Access Point Type
5 properties
1 required
NetworkType
string
Network type
ConnectionChangeOperation
object
Connection change operation data
3 properties
3 required
NetworkChangeStatus
string
Current outcome of the change flow
NetworkState
string
Network status
ServiceProfileLinkProtocolConfig
object
Configuration for dot1q to qinq translation support
5 properties
PhysicalPortType
string
Type of Port
SimplifiedMetadataEntity
object
Configuration details for port used at the access point.
10 properties
NetworkSimpleExpression
array
PaginationRequest
object
Pagination request information
2 properties
ConnectionPriority
string
Connection priority in redundancy group
VirtualDeviceInterface
object
Virtual Device Interface Information
3 properties
ServiceMetro
object
7 properties
NetworkChangeType
string
Type of change
PortType
string
Type of Port
AuthenticationKey
object
Authentication Key Support and Customization
3 properties
ServiceProfileMetadata
object
Metadata. Response attribute. Ignored on request payload.
19 properties
ServiceProfileVisibilityEnum
string
PortEncapsulation
object
Port encapsulation configuration
2 properties
PortOperation
object
Operational specifications for ports.
6 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
NetworkSortCriteria
object
2 properties
ConnectionRedundancy
object
Connection redundancy configuration
2 properties
marketplaceSubscription
object
Equinix Fabric Entity for Marketplace Subscription
3 properties
SimplifiedVirtualDevice
object
6 properties
PortTether
object
Port physical connection
7 properties
PhysicalPort
object
Physical Port specification
17 properties
ConnectionSideAdditionalInfo
object
Additional information
2 properties
NetworkChangeResponse
object
List of network changes
2 properties
NetworkConnections
object
List of network changes
2 properties
ServiceTokenType
string
Type of Service Token
PortAdditionalInfo
object
Additional information
2 properties
CloudRouter
object
Fabric Cloud Router object
9 properties
Tags
array
ServiceProfileAccessPointTypeEnum
string
Access point type
NetworkUpdateRequest
array
Fabric Network Update Request
SimplifiedNotification
object
4 properties
2 required
Network
object
Network specification
NetworkSortBy
string
Possible field names to use on sorting
ProviderStatus
string
Connection provider readiness status
SimplifiedLocation
object
5 properties
PhysicalPortSettings
object
Physical Port configuration settings
2 properties
ConnectionDirection
string
Connection directionality from the requester point of view
Bandwidth
integer
speed in Mbps
Link
object
5 properties
NetworkPostRequest
object
Create Network
6 properties
4 required
Pagination
object
Pagination response information
5 properties
2 required
NetworkScope
string
Network scope
NetworkSortDirectionResponse
string
Sorting direction
NetworkSearchResponse
object
List of networks
3 properties
PortLoa
object
Port Loas
2 properties
PortDevice
object
Port device
3 properties
CloudRouterChangeOperation
object
Fabric Cloud Router change operation data
3 properties
3 required
NetworkOperation
object
Network operational data
1 property
PortOrder
object
6 properties
SimplifiedNetwork
object
Network specification
12 properties
1 required
ServiceProfileAccessPointCOLO
object
Colo Access Point
6 properties
2 required
SimplifiedLinkProtocol
object
Connection link protocol Configuration
4 properties
VirtualNetwork
object
Virtual Network Information
2 properties
CloudRouterChange
object
Current state of latest CloudRouter change
7 properties
2 required
ServiceProfileAccessPointType
object
Access Point Type
NetworkSearchFieldName
string
Possible field names to use on filters
ConnectionOperation
object
Connection type-specific operational data
5 properties
NetworkChange
object
Current state of latest network change
7 properties
PortOrderSignatureDelegate
object
order delegate details
3 properties
CustomField
object
Define Custom Attributes
6 properties
3 required
ConnectionType
string
Connection type
NetworkSearchRequest
object
Search requests containing criteria
3 properties
PriceError_additionalInfo
object
2 properties
ChangeId_5
string
Network Change 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
NetworkSortCriteriaResponse
object
2 properties
ConnectionSide
object
Connection configuration object for each side of multi-segment connection
3 properties
MarketingInfo
object
3 properties
ServiceProfileAccessPointTypeCOLO
object
Colo Access Point Type
16 properties
1 required
MetalInterconnection
object
Metal Interconnection
1 property
ErrorList
array
List of Error Message
NetworkId
string
Network UUID
CloudRouterAccessPointState
string
Access point lifecycle state
PortOrderSignature
object
Port signature details
2 properties
PortDeviceRedundancy
object
Device redundancy
2 properties
Order
object
7 properties
ServiceTokenSide
object
Connection link protocol,virtual device or network configuration
1 property
SimplifiedAccount
object
12 properties
Project
object
1 property
1 required
PortNotification
object
2 properties
2 required
PortRedundancy
object
Port redundancy configuration
3 properties
SimplifiedLocationWithoutIBX
object
4 properties
1 required
CloudRouterPostRequestBase
object
Create Cloud Router
9 properties
ServiceTokenConnection
object
Service Token Connection Type Information
9 properties
PortDemarcationPoint
object
Customer physical Port
8 properties
Error
object
Error Response with details
6 properties
2 required
PortOrderPurchaseOrder
object
purchase order
7 properties
SimplifiedPort
object
Port specification
30 properties
Package
object
Package settings for port
2 properties
SimplifiedTokenNetwork
object
6 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 Connections API
Equinix Console Log Details API
#Networks