How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Equinix

Equinix Interconnections API

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/).

Documentation Provider Profile APIs.io OpenAPI GitHub

Equinix Interconnections API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Interconnections. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 15 operations across 8 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.equinix.com/metal/v1.

15 operations 8 paths 47 schemas 2 DELETE8 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.equinix.com
Authentication
API Key
Contact
Equinix Metal API Team
License
Equinix Metal
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Equinix Interconnections API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (x_auth_token). By default, every request must be authenticated.

  • x_auth_token — HTTP header containing the User or Project API key that will be used to authenticate the request.

Paths & Operations 15

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…

DELETE
/connections/{connection_id}
Delete interconnection
deleteInterconnection 3 params → 202403404
GET
/connections/{connection_id}
Get interconnection
getInterconnection 3 params → 200403404
PUT
/connections/{connection_id}
Update interconnection
updateInterconnection 3 params body → 200403404
GET
/connections/{connection_id}/ports
List a interconnection's ports
listInterconnectionPorts 1 param → 200403404
GET
/connections/{connection_id}/virtual-circuits
List a interconnection's virtual circuits
listInterconnectionVirtualCircuits 1 param → 200403404
GET
/connections/{connection_id}/ports/{id}
Get a interconnection port
getInterconnectionPort 4 params → 200403404
GET
/connections/{connection_id}/ports/{port_id}/virtual-circuits
List a interconnection port's virtual circuits
listInterconnectionPortVirtualCircuits 4 params → 200403404
POST
/connections/{connection_id}/ports/{port_id}/virtual-circuits
Create a new Virtual Circuit
createInterconnectionPortVirtualCircuit 2 params body → 201403404
GET
/organizations/{organization_id}/connections
List organization connections
organizationListInterconnections 3 params → 200403404
POST
/organizations/{organization_id}/connections
Request a new interconnection for the organization
createOrganizationInterconnection 3 params body → 201403404422
GET
/projects/{project_id}/connections
List project connections
projectListInterconnections 5 params → 200403404
POST
/projects/{project_id}/connections
Request a new interconnection for the project's organization
createProjectInterconnection 3 params body → 201403422
DELETE
/virtual-circuits/{id}
Delete a virtual circuit
deleteVirtualCircuit 3 params → 202403404
GET
/virtual-circuits/{id}
Get a virtual circuit
getVirtualCircuit 3 params → 200403404
PUT
/virtual-circuits/{id}
Update a virtual circuit
updateVirtualCircuit 3 params body → 200202403404

Schemas 47

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.

Address
object
7 properties 3 required
VlanVirtualCircuit_type
string
createOrganizationInterconnection_request
VirtualCircuitList
object
1 property
InterconnectionUpdateInput
object
6 properties
VlanFabricVcCreateInput
object
11 properties 5 required
Coordinates
object
2 properties
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
object
10 properties
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…
VlanFabricVcCreateInput_type
string
When requesting for a Fabric VC, the value of this field should be 'shared'.
InterconnectionPortList
object
1 property
InterconnectionList
object
2 properties
Meta
object
8 properties
VrfVirtualCircuit
object
18 properties 1 required
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
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…
VlanVirtualCircuitUpdateInput
object
5 properties
DedicatedPortCreateInput_type
string
When requesting for a dedicated port, the value of this field should be 'dedicated'.
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…
Organization
object
17 properties
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…
FabricServiceToken_role
string
Either primary or secondary, depending on which interconnection the service token is associated to.
Href
object
1 property 1 required
VrfVirtualCircuitCreateInput
object
12 properties 5 required
FabricServiceToken
object
6 properties
VlanVirtualCircuitCreateInput
object
7 properties 1 required
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.
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…
VrfIpReservation_type
string
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…
VrfFabricVcCreateInput
object
11 properties 6 required
VirtualCircuitUpdateInput
Vrf
object
17 properties
Interconnection_redundancy
string
Either 'primary', meaning a single interconnection, or 'redundant', meaning a redundant interconnection.
Metro
object
4 properties
VirtualCircuit
User
object
22 properties
VlanVirtualCircuit
object
15 properties
DedicatedPortCreateInput
object
12 properties 4 required
Interconnection
object
19 properties
FabricServiceToken_service_token_type
string
Either 'aside' or 'zside', depending on which type of Fabric VC was requested.
InterconnectionPort_role
string
Either 'primary' or 'secondary'.
VrfVirtualCircuitUpdateInput
object
9 properties
Project
object
19 properties
VirtualCircuitCreateInput
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…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-interconnections-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
AE Profile APIs.io
Equinix Agents API
AE Profile APIs.io
Equinix Authentication API
AE Profile APIs.io
Equinix availability API
AE Profile APIs.io
Equinix Batches API
AE Profile APIs.io
Equinix BGP API
AE Profile APIs.io
Equinix Capacity API
AE Profile APIs.io
Equinix Cloud Events API
AE Profile APIs.io
Equinix Cloud Routers API
AE Profile APIs.io
Equinix Company Profiles API
AE Profile APIs.io
Equinix Connections API
AE Profile APIs.io
Equinix Console Log Details API
AE Profile APIs.io
#Interconnections
← Back to E APIs
API Details
ID
equinix:equinix-interconnections-api
Base URL
https://api.equinix.com
Docs
https://developer.equinix.com/catalog/fabricv4
Provider
Equinix
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=equinix-interconnections-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/equinix-interconnections-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Equinix Interconnections API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.