Network Interconnections. See Instructions to create Network Interconnections at Check out the product docs to learn more about [Equinix Fabric](https://metal.equinix.com/developers/docs/networking/fabric/).
Across 8 paths, the API surfaces 15 operations — 2 DELETE, 8 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Interconnections 15
Network Interconnections. See Instructions to create Network Interconnections at Check out the product docs to learn more about [Equinix Fabric](https://metal.equinix.com/develope…
The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are User (22 properties), Interconnection (19 properties), Project (19 properties), VrfVirtualCircuit (18 properties). Each schema is shown below with its type and property counts.
VlanFabricVcCreateInput_service_token_type
string
Either 'aside' or 'zside'. Setting this field to 'aside' will create an interconnection with Fabric VCs (Metal Billed). Setting this field to 'zside' will crea…
VrfVirtualCircuit_status
string
The status changes of a VRF virtual circuit are generally the same as Virtual Circuits that aren't in a VRF. However, for VRF Virtual Circuits on Fabric VCs, t…
VlanVirtualCircuit
object
15 properties
DedicatedPortCreateInput
object
12 properties4 required
Meta
object
8 properties
VirtualCircuitUpdateInput
Interconnection_mode
string
The mode of the interconnection (only relevant to Dedicated Ports). Shared connections won't have this field. Can be either 'standard' or 'tunnel'. The default…
InterconnectionPort_role
string
Either 'primary' or 'secondary'.
VrfVirtualCircuit
object
18 properties1 required
Address
object
7 properties3 required
InterconnectionPort_status
string
For both Fabric VCs and Dedicated Ports, this will be 'requested' on creation and 'deleting' on deletion. Once the Fabric VC has found its corresponding Fabric…
VlanVirtualCircuit_status
string
The status of a Virtual Circuit is always 'pending' on creation. The status can turn to 'Waiting on Customer VLAN' if a Metro VLAN was not set yet on the Virtu…
InterconnectionPort
object
10 properties
Interconnection_redundancy
string
Either 'primary', meaning a single interconnection, or 'redundant', meaning a redundant interconnection.
DedicatedPortCreateInput_mode
string
The mode of the interconnection (only relevant to Dedicated Ports). Fabric VCs won't have this field. Can be either 'standard' or 'tunnel'. The default mode of…
DedicatedPortCreateInput_type
string
When requesting for a dedicated port, the value of this field should be 'dedicated'.
InterconnectionPortList
object
1 property
Organization
object
17 properties
VrfFabricVcCreateInput
object
11 properties6 required
createOrganizationInterconnection_request
Interconnection
object
19 properties
InterconnectionList
object
2 properties
Project_type
string
The type of the project. Projects of type vmce are part of an in development feature and not available to all customers.
Vrf
object
17 properties
VlanFabricVcCreateInput
object
11 properties5 required
VirtualCircuitCreateInput
VirtualCircuitList
object
1 property
VrfIpReservation_type
string
FabricServiceToken_role
string
Either primary or secondary, depending on which interconnection the service token is associated to.
FabricServiceToken
object
6 properties
VrfVirtualCircuitUpdateInput
object
9 properties
VlanVirtualCircuitUpdateInput
object
5 properties
Project
object
19 properties
FabricServiceToken_state
string
The state of the service token that corresponds with the service token state on Fabric. An 'inactive' state refers to a token that has not been redeemed yet on…
Coordinates
object
2 properties
InterconnectionUpdateInput
object
6 properties
VlanFabricVcCreateInput_type
string
When requesting for a Fabric VC, the value of this field should be 'shared'.
VirtualCircuit
User
object
22 properties
Metro
object
4 properties
Error
object
Error responses are included with 4xx and 5xx HTTP responses from the API service. Either "error" or "errors" will be set.
2 properties
VlanVirtualCircuit_type
string
Interconnection_type
string
The 'shared' type of interconnection refers to shared connections, or later also known as Fabric Virtual Connections (or Fabric VCs). The 'dedicated' type of i…
FabricServiceToken_service_token_type
string
Either 'aside' or 'zside', depending on which type of Fabric VC was requested.
VlanVirtualCircuitCreateInput
object
7 properties1 required
VrfVirtualCircuitCreateInput
object
12 properties5 required
Href
object
1 property1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
