Equinix Fabric API v4 | Equinix Product Documentation

Create Port

Request

Creates Equinix Fabric™ Port

Security

BearerAuth

Query

dryRunboolean

option to verify that API calls will succeed

Default:false

Bodyapplication/jsonrequired

typestring(PortType)required

Type of Port

Value:"XF_PORT"

physicalPortsSpeedinteger, >= 0required

Physical Ports Speed in Mbps

physicalPortsTypestringrequired

Physical Ports Type. 10GBASE_SMF is only applicable for IX ports

Enum:"1000BASE_LX""10GBASE_LR""100GBASE_LR4""10GBASE_ER""1000BASE_SX""10GBASE_SMF""400GBASE_LR4"

physicalPortsCountinteger

connectivitySourceTypestringrequired

Port connectivity type

Enum:"COLO""BMMR""REMOTE"

bmmrTypestring

BMMR Type is mandatory when connectivitySourceType is BMMR

Enum:"SELF""EQUINIX"

projectobject(Project)required

orderobject(PortOrder)

accountobject(SimplifiedAccountRequest)required

serviceCodestring(PortServiceCode)

Identifies the service type associated with this port

Enum:"CX""IX""IA""MC"

locationobject(SimplifiedLocationRequest)required

demarcationPointIbxstring

A-side/Equinix ibx

tetherIbxstring

z-side/Equinix ibx

demarcationPointobject(PortDemarcationPoint)

Customer physical Port

redundancyobject(PortRedundancy)

Port redundancy configuration

encapsulationobject(PortEncapsulation)required

Port encapsulation configuration

lagEnabledboolean

Indicates whether Link Aggregation Group (LAG) is enabled on this port

packageobject(Package)

Package settings for port

notificationsArray of objects(PortNotification)

Notification preferences

physicalPortsArray of objects(PhysicalPort)

Physical ports that implement this port

loasArray of objects(PortLoa)

Port Loas

serviceTypestringdeprecated

Port service Type

Enum:"EPL""MSP"

bandwidthinteger, >= 0deprecated

Equinix assigned response attribute for Port bandwidth in Mbps

Payload

{
  "type": "XF_PORT",
  "physicalPortsSpeed": 1000,
  "physicalPortsType": "1000BASE_LX",
  "connectivitySourceType": "COLO",
  "location": {
    "metroCode": "GV"
  },
  "demarcationPointIbx": "GV1",
  "package": {
    "code": "STANDARD"
  },
  "lagEnabled": false,
  "encapsulation": {
    "type": "DOT1Q",
    "tagProtocolId": "0x8100"
  },
  "project": {
    "projectId": "8f23b36f-db8f-44c8-a6e5-606e1b485931'"
  },
  "account": {
    "accountNumber": 270848
  },
  "notifications": [
    { … }
  ],
  "order": {
    "purchaseOrder": { … },
    "signature": { … }
  },
  "physicalPorts": [
    { … }
  ]
}

Responses

Successful operation

Bodyapplication/json

hrefstring, (uri)read-only

Equinix assigned response attribute for an absolute URL that is the subject of the link's context.

typestring(PortType)

Type of Port

Value:"XF_PORT"

uuidstring, (uuid)

Equinix assigned response attribute for port identifier

namestring

Equinix assigned response attribute for Port name

descriptionstring

Equinix assigned response attribute for Port description

physicalPortsSpeedinteger, >= 0

Physical Ports Speed in Mbps

connectionsCountinteger, >= 0

Equinix assigned response attribute for Connection count

physicalPortsTypestring

Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports

Enum:"1000BASE_LX""10GBASE_LR""100GBASE_LR4""10GBASE_ER""1000BASE_SX""10GBASE_SMF""400GBASE_LR4"

physicalPortsCountinteger

connectivitySourceTypestring

Port connectivity type

Enum:"COLO""BMMR""REMOTE"

bmmrTypestring

Enum:"SELF""EQUINIX"

projectobject(Project)

statestring(PortState)

Port lifecycle state

Enum:"PENDING""PROVISIONING""REPROVISIONING""PENDING_CROSS_CONNECT""PROVISIONED""ACTIVE""DEPROVISIONING""DEPROVISIONED""INACTIVE""FAILED"

orderobject(PortOrder)

operationobject(PortOperation)

Operational specifications for ports.

accountobject(SimplifiedAccount)

changeobject(PortChange)

Current state of latest port change

changeLogobject(Changelog)

Change log

serviceCodestring(PortServiceCode)

Identifies the service type associated with this port

Enum:"CX""IX""IA""MC"

availableBandwidthinteger, >= 0

Equinix assigned response attribute for Port available bandwidth in Mbps

usedBandwidthinteger, >= 0

Equinix assigned response attribute for Port used bandwidth in Mbps

locationobject(SimplifiedLocation)

deviceobject(PortDevice)

Port device

interfaceobject(PortInterface)

Port interface

demarcationPointIbxstring

A-side/Equinix ibx

tetherIbxstring

z-side/Equinix ibx

demarcationPointobject(PortDemarcationPoint)

Customer physical Port

redundancyobject(PortRedundancy)

Port redundancy configuration

encapsulationobject(PortEncapsulation)

Port encapsulation configuration

lagEnabledboolean

If LAG enabled

asninteger

Port ASN

packageobject(Package)

Package settings for port

settingsobject(PortSettings)

Port configuration settings

physicalPortQuantityinteger

Number of physical ports

notificationsArray of objects(PortNotification)

Notification preferences

additionalInfoArray of objects(PortAdditionalInfo)

Port additional information

physicalPortsArray of objects(PhysicalPort)

Physical ports that implement this port

loasArray of objects(PortLoa)

Port Loas

marketplaceSubscriptionobject(marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

serviceTypestringdeprecated

Port service Type

Enum:"EPL""MSP"

bandwidthinteger, >= 0deprecated

Equinix assigned response attribute for Port bandwidth in Mbps

lagobject(PortLag)deprecated

Port Lag

Response

{
  "type": "XF_PORT",
  "physicalPortsType": "10GBASE_LR",
  "physicalPortsSpeed": 10000,
  "physicalPortsCount": 1,
  "location": {
    "metroCode": "AM"
  },
  "demarcationPointIbx": "AM1",
  "redundancy": {
    "group": "1",
    "priority": "PRIMARY"
  },
  "lagEnabled": true,
  "encapsulation": {
    "type": "DOT1Q",
    "tagProtocolId": "0x8100"
  },
  "package": {
    "code": "STANDARD"
  },
  "settings": {
    "sharedPortType": false
  },
  "project": {
    "projectId": "567"
  },
  "account": {
    "accountNumber": 1000
  },
  "order": {
    "orderNumber": "1-207799950758",
    "signature": { … }
  },
  "notifications": [
    { … },
    { … },
    { … },
    { … }
  ]
}