Equinix Ports API
Port ManagementCheck out the product docs to learn more about [Port configurations](https://metal.equinix.com/developers/docs/layer2-networking/overview/).
Equinix Ports API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Ports. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 22 operations across 17 paths, and defines 82 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.
22 operations
17 paths
82 schemas
2 DELETE8 GET1 PATCH11 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 22
Across 17 paths, the API surfaces 22 operations — 2 DELETE, 8 GET, 1 PATCH, 11 POST. Each is listed below with its method, path, parameters, and response codes.
Ports 22
Port ManagementCheck out the product docs to learn more about [Port configurations](https://metal.equinix.com/developers/docs/layer2-networking/overview/).
GET
/ports/{id}
Retrieve a port
POST
/ports/{id}/assign
Assign a port to virtual network
POST
/ports/{id}/bond
Enabling bonding
POST
/ports/{id}/convert/layer-2
Convert to Layer 2
POST
/ports/{id}/convert/layer-3
Convert to Layer 3
POST
/ports/{id}/disbond
Disabling bonding
DELETE
/ports/{id}/native-vlan
Remove native VLAN
POST
/ports/{id}/native-vlan
Assign a native VLAN
POST
/ports/{id}/unassign
Unassign a port
GET
/ports/{id}/vlan-assignments
List Current VLAN assignments for a port
GET
/ports/{id}/vlan-assignments/{assignment_id}
Show a particular Port VLAN assignment's details
GET
/ports/{id}/vlan-assignments/batches
List the VLAN Assignment Batches for a port
POST
/ports/{id}/vlan-assignments/batches
Create a new Port-VLAN Assignment management batch
GET
/ports/{id}/vlan-assignments/batches/{batch_id}
Retrieve a VLAN Assignment Batch's details
GET
/fabric/v4/ports
Get All Ports
POST
/fabric/v4/ports
Create Port
POST
/fabric/v4/ports/{portId}/physicalPorts/bulk
Add to Lag
GET
/fabric/v4/ports/{portId}
Get Port by uuid
DELETE
/fabric/v4/ports/{portId}
Delete a single port
PATCH
/fabric/v4/ports/{portId}
Update by UUID
GET
/fabric/v4/ports/{portUuid}/linkProtocols
Get Vlans
POST
/fabric/v4/ports/search
Search ports
Schemas 82
The contract defines 82 schemas that model the data the API accepts and returns. The most detailed are Port_2 (44 properties), PortRequest (33 properties), PhysicalPort (17 properties), LinkProtocolResponse (16 properties). Each schema is shown below with its type and property counts.
PortAssignInput
object
1 property
Port
object
Port is a hardware port associated with a reserved or instantiated hardware device.
10 properties
PortVlanAssignmentBatch
object
9 properties
PortVlanAssignmentBatchList
object
1 property
PortVlanAssignment_state
string
PortVlanAssignmentList
object
1 property
PortData
object
2 properties
PortConvertLayer3Input
object
1 property
BondPortData
object
2 properties
PortVlanAssignment
object
8 properties
PortConvertLayer3Input_request_ips_inner
object
2 properties
PortVlanAssignmentBatchCreateInput
object
1 property
Port_type
string
Type is either "NetworkBondPort" for bond ports or "NetworkPort" for bondable ethernet ports
VirtualNetwork
object
13 properties
Port_network_type
string
Composite network type of the bond
MetalGatewayLite
object
7 properties
PortVlanAssignmentBatch_state
string
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
PortVlanAssignmentBatch_vlan_assignments_inner_state
string
MetalGateway_state
string
The current state of the Metal Gateway. 'Ready' indicates the gateway record has been configured, but is currently not active on the network. 'Active' indicate…
PortVlanAssignmentBatch_vlan_assignments_inner
object
4 properties
Href
object
1 property
1 required
PortVlanAssignmentBatchCreateInput_vlan_assignments_inner
object
3 properties
PortRequest
object
PortRequest is the Request Object for creating single and bulk fabric ports
33 properties
8 required
PortServiceCode
string
type of product
PortState
string
Port lifecycle state
PortPriority
string
Port priority in redundancy group
PortInterface
object
Port interface
1 property
EndCustomer
object
3 properties
PortUUID
string
Port UUID
PhysicalPortType
string
Type of Port
PaginationRequest
object
Pagination request information
2 properties
PortType
string
Type of Port
PortUpdateRequest
array
Port Update Request
PortEncapsulation
object
Port encapsulation configuration
2 properties
PortOperation
object
Operational specifications for ports.
6 properties
PortSettings
object
Port configuration settings
7 properties
Changelog
object
Change log
12 properties
marketplaceSubscription
object
Equinix Fabric Entity for Marketplace Subscription
3 properties
PortTether
object
Port physical connection
7 properties
LinkProtocolResponse
object
Link Protocol response
16 properties
PhysicalPort
object
Physical Port specification
17 properties
PortSearchFieldName
string
Possible field names to use on filters
PortAdditionalInfo
object
Additional information
2 properties
LinkProtocolServiceToken
object
Service Token details of Link Protocol
4 properties
PortLag
object
Port Lag
4 properties
SimplifiedLocation
object
5 properties
SubInterface
object
Sub Interface information
2 properties
PhysicalPortSettings
object
Physical Port configuration settings
2 properties
Pagination
object
Pagination response information
5 properties
2 required
PortSortDirection
string
Sorting direction
Port_2
object
Port specification
44 properties
LinkProtocolGetResponse
object
List of Vlans
2 properties
PortSortBy
string
Possible field names to use on sorting
PortLoa
object
Port Loas
2 properties
PortDevice
object
Port device
3 properties
PortChange
object
Current state of latest port change
7 properties
PortOrder
object
6 properties
PortOrderSignatureDelegate
object
order delegate details
3 properties
AllPortsResponse
object
GET All User Port Across Fabric Metros
2 properties
LinkProtocolRequestType
string
Type of Link Protocol
AllPhysicalPortsResponse
object
GET All Physical Ports
2 properties
PriceError_additionalInfo
object
2 properties
LinkProtocolConnection
object
Connection details of Link Protocol
4 properties
BulkPhysicalPort
object
Add to Lag request
1 property
ErrorList
array
List of Error Message
PortV4SearchRequest
object
Search requests containing criteria
3 properties
1 required
PortExpressions
array
PortOrderSignature
object
Port signature details
2 properties
PortDeviceRedundancy
object
Device redundancy
2 properties
SimplifiedAccount
object
12 properties
Project
object
1 property
1 required
PortNotification
object
2 properties
2 required
PortExpression
object
Either use 'and' for AND operations, 'or' for OR operations, or specify 'property', 'operator', and 'values' for field filtering. Only one of these patterns sh…
5 properties
PortRedundancy
object
Port redundancy configuration
3 properties
PortChangeOperation
object
Port change operation data
3 properties
3 required
PortDemarcationPoint
object
Customer physical Port
8 properties
Error_2
object
Error Response with details
6 properties
2 required
PortOrderPurchaseOrder
object
purchase order
7 properties
Package
object
Package settings for port
2 properties
LinkProtocolState
string
Network status
PortSortCriteria
object
2 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
#Ports