Ports

Create Port

POST /fabric/v4/ports
Method POST
URL or Endpoint /fabric/v4/ports
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters type, physicalPortsSpeed, physicalPortsType, connectivitySourceType, location, project, demarcationPointIbx, tetherIbx, settings, lagEnabled, encapsulation, account, notifications, physicalPorts

This API request creates a virtual Fabric port that can be used as an endpoint in virtual connections.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.


Sample curl request - colocation, non-LAG port

Copy 
curl -X POST 'https://api.equinix.com/fabric/v4/ports'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'
-d '{
    "type": "XF_PORT",
    "physicalPortsSpeed": 1000,
    "physicalPortsType": "1000BASE_LX",
    "connectivitySourceType": "COLO",
    "location": {
        "metroCode": "GV"
    },
    "project": {
        "projectId": "1234567"
    },

    "demarcationPointIbx": "GV1",
    "settings": {
        "packageType": "STANDARD"
    },
    "lagEnabled": false,
    "encapsulation": {
        "type": "DOT1Q",
        "tagProtocolId": "33024"
    },
    "account": {
        "accountNumber": 270848
    },
    "notifications": [
        {
            "registeredUsers": [
                "jaguarsuser-port-order"
            ],
            "type": "TECHNICAL"
        }
    ],
    "physicalPorts": [
        {
            "demarcationPoint": {
                "ibx": "GV1",
                "cabinetUniqueSpaceId": "Demarc",
                "cageUniqueSpaceId": "GV1:01:002174",
                "patchPanel": "CP:Demarc:1259684",
                "patchPanelPortA": 8,
                "patchPanelPortB": 9,
                "connectorType": "SC"
            }
        },
        {
            "demarcationPoint": {
                "ibx": "GV1",
                "cabinetUniqueSpaceId": "Demarc",
                "cageUniqueSpaceId": "GV1:01:002174",
                "patchPanel": "CP:Demarc:1259684",
                "patchPanelPortA": 10,
                "patchPanelPortB": 11,
                "connectorType": "SC"
            }
        }
    ]
}'

Body parameters

Parameter
Description
type string
REQUIRED
 Port instance type.
Applicable values: XF_PORT - Fabric port
physicalPortsSpeed integer
REQUIRED
 Rated port bandwidth capacity in Mbps.
Example: 1000
physicalPortsType string
REQUIRED

Physical ports type.
Example 1000BASE_LX

connectivitySourceType string
REQUIRED
 Port type based on its location in the data center facility.
Applicable values:
  • COLO - Customer's cage in Equinix IBX colocation space.
  • BMMR
  • REMOTE
location object
REQUIRED
 Geographic attributes of the port.
metroCode string
REQUIRED
 Metropolitan area identifier.
Example: GV
project object
OPTIONAL
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
OPTIONAL
 Customer project identifier.
Example: 377533000114703
demarcationPointIbx string
REQUIRED
 Physical ports demarcation point IBX.
Example: GV1
tetherIbx string
OPTIONAL
 Physical ports tether IBX.
Example: GV1
settings object
REQUIRED
 Port configuration settings.
packageType string
REQUIRED
 Port package determinig its use.
Applicable values:
  • STANDARD
  • UNLIMITED
  • UNLIMITED_PLUS
lagEnabled boolean
REQUIRED
 Indicator showing if port is LAG enabled.
Example: false
encapsulation object
REQUIRED
 Encapsulation specification.
type string
REQUIRED
 Encapsulation protocol.
Applicable values:
  • DOT1Q
  • QINQ
  • UNTAGGED
  • NULL
tagProtocolId string
REQUIRED
 Ethertype value that identifies the tagging protocol.
Applicable values:
  • 33024
  • 34984
  • 37120
  • 37376
  • NONE
account object
REQUIRED
 Account information.
accountNumber integer
REQUIRED
 Equinix-assigned account number.
Example: 24124
notifications array[object]
REQUIRED
 Notifications settings for messages related to the asset configuration or its status.
registeredUsers array[string]
REQUIRED
 Usernames of registered users.
Example: ["mikeScott","dwightShrute"]
type string
REQUIRED
 Notification messages category.
Applicable values:
  • NOTIFICATION - Notifications related to asset's lifecycle.
  • TECHNICAL - Contact information for technical inquiries.
physicalPorts array[object]
OPTIONAL
 Physical ports that implement virtual port instance.
demarcationPoint object
OPTIONAL
 Customer-side physical port connector information.
ibx string
OPTIONAL
 IBX data center identifier.
Example: GV1
cabinetUniqueSpaceId string
OPTIONAL
 Identifier of the colocation space where the cabinet is located.
Example: AM1:02:032575:0105
cageUniqueSpaceId string
OPTIONAL
 Identifier of the colocation space where the cage is located.
Example: AM1:02:032575
patchPanel string
OPTIONAL
 Patch panel identifier.
Example: CP:Demarc:1259684
patchPanelPortA integer
OPTIONAL
 Patch panel port number. If the port number isn't provided, next available port is selected.
Example: 8
patchPanelPortB integer
OPTIONAL
 Patch panel port number. If the port number isn't provided, next available port is selected.
Example: 9
connectorType string
OPTIONAL
 Physical port connector type.
Applicable values: For applicable values, use the Lookup - Get Patch Panel Details.
Example: ST

Sample response

Copy 
{
    "href": "https://api.equinix.com/fabric/v4/ports/0f6bdb36-e130-4924-b038-ee1785fad166",
    "type": "XF_PORT",
    "uuid": "0f6bdb36-e130-4924-b038-ee1785fad166",
    "state": "PENDING",
    "physicalPortsType": "10GBASE_LR",
    "physicalPortsSpeed": 10000,
    "physicalPortsCount": 1,
    "location": {
        "metroCode": "AM"
    },
    "project": {
        "projectId": "1234567"
    },

    "demarcationPointIbx": "AM1",
    "redundancy": {
        "group": "1f6bdb37-f131-5925-c039-fe1785fad165",
        "priority": "PRIMARY"
        
    },
    "lagEnabled": false,
    "encapsulation": {
        "type": "DOT1Q",
        "tagProtocolId": "33024"
    },
    "settings": {
        "sharedPortType": false,
        "packageType": "STANDARD"
    },
    "account": {
        "accountNumber": 1000
    },
    "order": {
        "orderNumber": "1-207799950758"
    },
    "notifications": [
        {
            "type": "TECHNICAL",
            "registeredUsers": [
                "jaguarsuser-port-order"
            ]
        },
        {
            "type": "NOTIFICATION",
            "registeredUsers": [
                "jaguarsuser-port-order"
            ]
        }
    ],
    "physicalPorts": [
        {
            "demarcationPoint": {
                "ibx": "GV1",
                "cabinetUniqueSpaceId": "Demarc",
                "cageUniqueSpaceId": "GV1:01:002174",
                "patchPanel": "CP:Demarc:1259684",
                "patchPanelPortA": 8,
                "patchPanelPortB": 9,
                "connectorType": "SC"
            }
        },
        {
            "demarcationPoint": {
                "ibx": "GV1",
                "cabinetUniqueSpaceId": "Demarc",
                "cageUniqueSpaceId": "GV1:01:002174",
                "patchPanel": "CP:Demarc:1259684",
                "patchPanelPortA": 10,
                "patchPanelPortB": 11,
                "connectorType": "SC"
            }
        }
    ]
}

Response payload body description

Parameter
Description
href string
 Absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/ports/0f6bdb36-e130-4924-b038-ee1785fad166
type string
 Port instance type.
Possible values: XF_PORT - Fabric port
uuid string
 Port instance identifier.
Example: 0f6bdb36-e130-4924-b038-ee1785fad166
state string
 Fabric port operational status.
Example: PENDING
physicalPortsSpeed integer
 Rated port bandwidth capacity in Mbps.
Example: 1000
physicalPortsType string
 Physical ports type.
Example: 1000BASE_LX
physicalPortsCount integer
 Number of physical ports that comprise the given virtual port instance.
Example: 1
location object
 Geographic attributes of the port.
metroCode string
 Mtropolitan area identifier.
Example: AM
project object
OPTIONAL
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
OPTIONAL
 Customer project identifier.
Example: 377533000114703
demarcationPointIbx string
REQUIRED
 Physical ports demarcation point IBX.
Example: AM1
tetherIbx string
OPTIONAL
 Physical ports tether point IBX.
Example: AM1
device object
 Device configuration settings.
name string
 Equinix-assigned device identifier.
Example: dev-int-vsim-2.lab
redundancy object
 Device redundancy configuration.
group integer
 Device redundancy group.
Example: 1
priority string
 Relative priority in redundancy group.
Example: PRIMARY
lagEnabled boolean
 Indicator showing if port is LAG enabled.
Example: false
encapsulation object
 Encapsulation specification.
type string
 Encapsulation protocol.
Possible values:
  • DOT1Q
  • QINQ
  • UNTAGGED
  • NULL
tagProtocolId string
 Tagging protocol identifier.
Possible values:
  • 33024
  • 34984
  • 37120
  • 37376
  • NONE
settings object
 Port configuration settings.
sharedPortType boolean
 A shared port is a single physical port that handles multiple virtual connections. True value signifies a port that can handle multiple virtual connections.
Example: true
packageType string
 Package type.
Possible values:
  • STANDARD
  • UNTAGGED
  • UNLIMITED
  • FREE
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 24124
order object
 Asset order information.
orderNumber string
 Asset order number.
Example: 1-207799950758
notifications array[object]
 Notifications settings for messages related to the asset configuration or its status.
registeredUsers array[string]
 Usernames of registered users.
Example: ["mikeScott","dwightShrute"]
type string
 Notification messages category.
Possible values:
  • NOTIFICATION - Notifications related to asset's lifecycle.
  • TECHNICAL - Contact information for technical inquiries.
physicalPorts array[object]
 Physical ports that implement virtual port instance.
demarcationPoint object
 Customer-side physical port connector information.
ibx string
 IBX data center identifier.
Example: GV1
cabinetUniqueSpaceId string
 Identifier of the colocation space where the cabinet is located.
Example: AM1:02:032575:0105
cageUniqueSpaceId string
 Identifier of the colocation space where the cage is located.
Example: AM1:02:032575
patchPanel string
 Patch panel identifier.
Example: CP:Demarc:1259684
connectorType string
 Physical port connector type.
Example:
  • SC

Create Pair of Redundant Ports

POST /fabric/v4/ports/bulk
Method POST
URL or Endpoint /fabric/v4/ports/bulk
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters type, description, physicalPortsSpeed, physicalPortsType, connectivitySourceType, location, project, demarcationPointIbx, tetherIbx, settings, lag, encapsulation, account, notifications, physicalPorts

This API request creates a pair of redundant Fabric ports that can be used as an endpoint in virtual connections.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.


Sample curl request - redundant, colocation, non-LAG ports

Copy 
curl -X POST 'https://api.equinix.com/fabric/v4/ports'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'
-d '{
    "data": [
        {
            "type": "XF_PORT",
            "name": "L2-DEV-USER01-CX-10G-PRIMARY",
            "description": "Test Redundant port in Amsterdam",
            "physicalPortsSpeed": 10000,
            "lagEnabled": false,
            "demarcationPointIbx": "AM1",
            "encapsulation": {
                "type": "DOT1Q",
                "tagProtocolId": "33024"
            },
            "account": {
                "accountNumber": 1000
            },
            "order": {
                "purchaseOrder": {
                    "number": 156576,
                    "amount": 10,
                    "startDate": "2018-06-11",
                    "endDate": "2018-07-11",
                    "selectionType": "NEW"
                },
                "signature": {
                    "signatory": "DELEGATE",
                    "delegate": {
                        "firstName": "John",
                        "lastName": "Doe",
                        "email": "john.doe@company.com"
                        }
                }
            },
            "redundancy": {
                "priority": "PRIMARY"
            },
            "project": {
                "projectId": "1234567"
            },
            "physicalPorts": [
                {
                    "demarcationPoint": {
                        "ibx": "AM1",
                        "cabinet": "AM1:02:032575:0105",
                        "cage": "AM1:02:032575",
                        "patchPanel": "PP:0105:1260379",
                        "patchPanelPortA": 14,
                        "patchPanelPortB": 15,
                        "connectorType": "LC"
                    }
                }
            ]
        },
        {
            "type": "XF_PORT",
            "name": "L2-DEV-USER01-CX-10G-SECONDARY",
            "description": "Test Redundant port in Amsterdam",
            "physicalPortsSpeed": 10000,
            "lagEnabled": false,
            "demarcationPointIbx": "AM1",
            "encapsulation": {
                "type": "DOT1Q",
                "tagProtocolId": "33024"
            },
            "account": {
                "accountNumber": 1000
            },
            "order": {
                "purchaseOrderNumber": "1-129105284100"
            },
            "redundancy": {
                "priority": "SECONDARY"
            },
            "project": {
                "projectId": "1234567"
            },
            "physicalPorts": [
                {
                    "demarcationPoint": {
                        "ibx": "AM1",
                        "cabinet": "AM1:02:032575:0105",
                        "cage": "AM1:02:032575",
                        "patchPanel": "PP:0105:1260379",
                        "patchPanelPortA": 16,
                        "patchPanelPortB": 17,
                        "connectorType": "LC"
                    }
                }
            ]
        }
    ]
}'

Body parameters

For body parameters descriptions, refer to the Response payload body parameters section in Create Port.

Sample response

Copy 
{
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/ports/0f6bdb36-e130-4924-b038-ee1785fad999",
            "type": "XF_PORT",
            "uuid": "0f6bdb36-e130-4924-b038-ee1785fad999",
            "state": "PENDING",
            "connectivitySourceType": "COLO",
            "physicalPortsType": "10GBASE_LR",
            "physicalPortsSpeed": 10000,
            "location": {
                "metroCode": "AM"
            },
            "project": {
                "projectId": "1234567"
            },
            "demarcationPointIbx": "AM1",
            "redundancy": {
                "group": 1,
                "priority": "PRIMARY"
            },
            "lagEnabled": false,
            "encapsulation": {
                "type": "DOT1Q",
                "tagProtocolId": "33024"
            },
            "settings": {
                "sharedPortType": false,
                "packageType": "STANDARD"
            },
            "account": {
                "accountNumber": 1000
            },
            "order": {
                "orderNumber": "1-210210611904"
            },
            "notifications": [
                {
                    "type": "TECHNICAL",
                    "registeredUsers": [
                        "jaguarsuser-port-order"
                    ]
                },
                {
                    "type": "NOTIFICATION",
                    "registeredUsers": [
                        "jaguarsuser-port-order"
                    ]
                }
        },
        {
            "href": "https://api.equinix.com/fabric/v4/ports/0f6bdb36-e130-4924-b038-ee1785fad999",
            "type": "XF_PORT",
            "uuid": "0f6bdb36-e130-4924-b038-ee1785fad999",
            "state": "PENDING",
            "connectivitySourceType": "COLO",
            "physicalPortsType": "10GBASE_LR",
            "physicalPortsSpeed": 10000,
            "location": {
                "metroCode": "AM"
            },
            "project": {
                "projectId": "1234567"
            },
            "demarcationPointIbx": "AM1",
            "redundancy": {
                "group": 1,
                "priority": "SECONDARY"
            },
            "lagEnabled": false,
            "encapsulation": {
                "type": "DOT1Q",
                "tagProtocolId": "33024"
            },
            "settings": {
                "sharedPortType": false,
                "packageType": "STANDARD"
            },
            "account": {
                "accountNumber": 1000
            },
            "order": {
                "orderNumber": "1-210210611904"
            }
        }
    ]
}

Response payload body description

For body parameters descriptions, refer to the Response payload body description section in Create Port.


Add Physical Ports to Virtual Port

POST /fabric/v4/ports/{uuid}/physicalPorts/bulk
Method POST
URL or Endpoint /fabric/v4/ports/{uuid}/physicalPorts/bulk
Headers Authorization, Content-Type
Path Parameters uuid
Query Parameters Not applicable
Body Parameters type, demarcationPoint, account, order

Adds physical ports to a virtual port.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.


Sample curl request - colocation, non-LAG port

Copy 
curl -X POST 'https://api.equinix.com/fabric/v4/ports/c64de7e5-7fe7-41e6-b984-80d5aa159a0d/physicalPorts/bulk'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'
-d '{
    "data": [
    {
        "type": "XF_PHYSICAL_PORT",
        "demarcationPoint": {
        "ibx": "AM1",
        "cabinetUniqueSpaceId": "AM1:02:032575:0105",
        "cageUniqueSpaceId": "AM1:02:032575",
        "patchPanel": "PP:0105:1260379",
        "patchPanelPortA": 14,
        "patchPanelPortB": 15,
        "connectorType": "LC"
        },
        "account": {
        "accountNumber": 17829
        },
        "order": {
        "purchaseOrder": {
            "number": 156576,
            "amount": 10,
            "startDate": "2018-06-11",
            "endDate": "2018-07-11",
            "selectionType": "NEW"
        },
        "signature": {
            "signatory": "DELEGATE",
            "delegate": {
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@company.com"
            }
        }
    },
    {
        "type": "XF_PHYSICAL_PORT",
        "account": {
        "accountNumber": 17829
        },
        "demarcationPoint": {
        "ibx": "AM1",
        "cabinetUniqueSpaceId": "AM1:02:032575:0105",
        "cageUniqueSpaceId": "AM1:02:032575",
        "patchPanel": "PP:0105:1260379",
        "patchPanelPortA": 16,
        "patchPanelPortB": 17,
        "connectorType": "LC"
        },
        "order": {
        "purchaseOrder": {
            "number": 156576,
            "amount": 10,
            "startDate": "2018-06-11",
            "endDate": "2018-07-11",
            "selectionType": "NEW"
        },
        "signature": {
            "signatory": "DELEGATE",
            "delegate": {
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@company.com"
            }
        }
        }
    }
    ]
}'

Path parameters

Parameter
Description
uuid string
REQUIRED
 Fabric port identifier.

Body parameters

Parameter
Description
data array[object]
REQUIRED
 Array of physical ports definitions.
type string
REQUIRED
 Port instance type.
Applicable values: XF_PORT - Fabric port
demarcationPoint object
REQUIRED
 Demarcation point.
ibx string
REQUIRED
 IBX data center identifier.
Example: GV1
cabinetUniqueSpaceId string
REQUIRED
 Identifier of the colocation space where the cabinet is located.
Example: AM1:02:032575:0105
cageUniqueSpaceId string
REQUIRED
 Identifier of the colocation space where the cage is located.
Example: AM1:02:032575
patchPanel string
REQUIRED
 Patch panel.
Example:CP:Demarc:1259684
patchPanelPortA integer
REQUIRED
 Patch panel PortA identifier.
Example: 14
patchPanelPortB integer
REQUIRED
 Patch panel PortB identifier.
Example: 15
connectorType string
REQUIRED
 Physical port connector type.
Applicable values:
  • SC
account object
OPTIONAL
 Port owner's account details.
accountNumber integer
OPTIONAL
 Port owner's account number.
Example: 17829
order object
OPTIONAL
 Order details.
purchaseOrder object
OPTIONAL
 Purchase order details.
number integer
OPTIONAL
 Purchase order number.
Example: 156576
amount integer
OPTIONAL
 Purchase order amount.
Example: 10
startDate string
OPTIONAL
 Purchase order start date.
Example: 2018-06-11
endDate string
OPTIONAL
 Purchase order end date.
Example: 2018-07-11
selectionTypestring
OPTIONAL
 Selection type.
Example: NEW
signature object
OPTIONAL
 Signature details.
signatory string
OPTIONAL
 Signatory details.
Applicable values:
  • DELEGATE
  • SELF
  • ACCOUNT_SUPPORT
delegate object
OPTIONAL
 Details of the delegate.
firstname string
OPTIONAL
 Firstname of the delegate.
lasttname string
OPTIONAL
 Lastname of the delegate.
email string
OPTIONAL
 Email of the delegate.
loas array[object]
OPTIONAL
 An array of objects containing the unique Ids of Letters of Agreements (LOAs).
uuid string
OPTIONAL
 Unique Ids of Letters of Agreements (LOAs).
Example: g42de7e5-7fe7-41e6-b984-80d5aa159a8m

Sample response

Copy 
{
    "data": [
    {
        "type": "XF_PHYSICAL_PORT",
        "demarcationPoint": {
        "cabinetUniqueSpaceId": "Demarc",
        "cageUniqueSpaceId": "GV1:01:002174",
        "patchPanel": "CP:Demarc:1259684",
        "patchPanelPortA": "39",
        "patchPanelPortB": "40",
        "connectorType": "SC",
        "ibx": "GV1"
        },
        "order": {
        "orderNumber": "1-210210611904"
        }
    },
    {
        "type": "XF_PHYSICAL_PORT",
        "demarcationPoint": {
        "cabinetUniqueSpaceId": "Demarc",
        "cageUniqueSpaceId": "GV1:01:002174",
        "patchPanel": "CP:Demarc:1259684",
        "patchPanelPortA": "41",
        "patchPanelPortB": "42",
        "connectorType": "SC",
        "ibx": "GV1"
        },
        "order": {
        "orderNumber": "1-210210611904"
        }
    }
    ]
}

Response payload description

Parameter
Description
pagination object Data set pagination information.
offset integer
 Index of the first item returned in the response.
Example: 0
limit integer
 Maximum number of items returned per page.
Example: 20
total integer
 Total number of items returned.
Example: 123
data array[object]
 Array of physical ports definitions.
type string
 Port instance type.
Example value: XF_PORT - Fabric port
demarcationPoint object
 Demarcation point details.
ibx string
 IBX data center identifier.
Example: GV1
cabinetUniqueSpaceId string
 Identifier of the colocation space where the cabinet is located.
Example: AM1:02:032575:0105
cageUniqueSpaceId string
 Identifier of the colocation space where the cage is located.
Example: AM1:02:032575
patchPanel string
 Patch panel identifier.
Example: CP:Demarc:1259684
patchPanelPortA integer
 Patch panel PortA identifier.
Example: 14
patchPanelPortB integer
 Patch panel PortB identifier.
Example: 15
connectorType string
 Physical port connector type.
Example values:
  • SC
portReservationId string
 Port reservation Id.
Example values:1793011453
portGroup string
 Port group.
Example values:
1886328826
key string
 Additional information parameter.
Example values:
  • internalReferenceId
  • quoteReferenceId
  • orderUuid
  • lagType
  • connectivitySourceType
  • physicalPortsType
  • packageType
  • notification
value string/integer
 Additional information parameter value. Note that the value's data type and its applicable values depend on the selected key parameter.
order object
 Order details.
orderNumber string
 Order number.
Example values:1-210210611904

Get All Ports

GET /fabric/v4/ports
Method GET
URL or Endpoint /fabric/v4/ports
Headers Authorization
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters Not applicable

This API request returns details of all available ports for the specified user credentials.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.


Sample curl request

Copy 
curl -X GET 'https://api.equinix.com/fabric/v4/ports'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Sample Response

Copy 
{
    "pagination": {
        "offset": 0,
        "limit": 999,
        "total": 133
    },
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-599b-99b0-8ce0-306a5c00a4ee",
            "type": "XF_PORT",
            "uuid": "c791f8cb-599b-99b0-8ce0-306a5c00a4ee",
            "name": "testBuyer-DC5-NL-Dot1q-BO-PRI-10G-JN-163",
            "physicalPortsSpeed": 1000,
            "connectivitySourceType": "COLO",
            "physicalPortsType",: "1000BASE_LX",
            "state": "ACTIVE",
            "cvpId": "1614613",
            "bandwidth": 10000,
            "usedBandwidth": 6165,
            "availableBandwidth": 3835,
            "location": {
                "href": "https://api.equinix.com/fabric/v4/metros/DC",
                "ibx": "DC5",
                "metroCode": "DC",
                "metroName": "Ashburn",
                "region": "AMER"
            },
            "project": {
                "projectId": "1234567"
            },

            "device": {
                "name": "qa3-dc-a1.lab",
                "redundancy": {
                    "priority": "PRIMARY"
                }
            },
            "encapsulation": {
                "type": "DOT1Q",
                "tagProtocolId": "0x8100"
            },
            "lag": {
                "enabled": false
            },
            "settings": {
                "buyout": true,
                "placeVcOrderPermission": true,
                "viewPortPermission": true
            },
            "physicalPorts": [
                {
                    "uuid": "dfd8884bb-4f65-4ab3-8f77-500dec2f87777",
                    "state": "ACTIVE",
                    "type": "XF_PHYSICAL_PORT",
                    "id": 1426515,
                    "bandwidth": 10000,
                    "tether": {
                        "crossConnectId": "ECX.01.00002995",
                        "cabinetNumber": "Demarc",
                        "systemName": "DC5:01:001015",
                        "patchPanelName": "PP:Demarc:00001016",
                        "patchPanelPortA": "1",
                        "patchPanelPortB": "2",
                    },
                    "demarcationPoint": {
                        "patchPanelName": "PP:Demarc:00001015",
                        "patchPanelPortA": "5",
                        "patchPanelPortB": "6",
                        "ibx": "DC5"
                    },
                    "settings": {
                        "sharedPortType": false,
                        "sharedPortProduct": "NA"
                    },
                    "operation": {
                        "operationalStatus": "UP",
                        "opStatusChangedAt": "2021-12-02T00:00:00Z"
                    }
                }
            ],
            "operation": {
                "operationalStatus": "UP",
                "opStatusChangedAt": "2021-07-20T17:04:18Z",
                "connectionCount": 53,
                "evplVCCount": 53,
                "fgVCCount": 0,
                "accessVCCount": 0
            },
            "account": {
                "accountNumber": 270001,
                "accountName": "testBuyer",
                "ucmId": "08374E19-9B56-4c27-84BA-33D42BB0940C",
                "globalCustId": "0016u000003JZ4sAAG",
                "orgId": "91997",
                "organizationName": "testBuyer-270001"
            },
            "changeLog": {
                "updatedDateTime": "2021-07-20T17:04:18Z",
                "createdDateTime": "2021-07-20T17:04:18Z"
            }
        }
    ]
}

Use the Metros API to create a list of all metros your account can connect to.


Response payload body description

Parameter Data Type Example Values Description
pagination object - Search results pagination settings.
data array[object] - Data array containing returned objects.
pagination
offset integer ?offset=0 Index of the first item returned in the response. The value must be >=0, and the default is 0.
limit integer ?limit=10 Maximum number of items returned per page. Number must be between 1 and 1000, and the default is 999.
total integer 1 Total number of items returned.
data
href string https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d An absolute URL that returns the specified asset.
type string XF_PORT Type of port.
uuid string e91484bb-4f65-4ab3-8f77-500dec2f855d Equinix-assigned port identifier.
name string AT1-Dot1q-L-Secondary-108608 Port name.
physicalPortsSpeed integer 0 Physical ports speed in Mbps.
physicalPortsType string 1000BASE_LX

Physical ports type.

  • 1000BASE_LX

  • 10GBASE_LR

  • 100GBASE_LR4

  • 10GBASE_ER

  • 1000BASE_SX
connectivitySourceType string COLO

Port connectivity type.

  • COLO

  • BMMR

  • REMOTE
state string ACTIVE Port lifecycle status.
cvpId string 108608 CloudVision Portal port identifier.
bandwidth integer 1000 Data transfer capacity (Mbps).
usedBandwidth integer 0 Port bandwidth consumed (Mbps).
availableBandwidth integer 1000 Remaining port bandwidth (Mbps).
location object - Geographic attributes of the specified access point.
project object - Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
device object - Device configuration settings.
encapsulation object - Encapsulation specification.
lag object - Link aggregation group (LAG) configuration.
settings object - Port configuration settings.
physicalPorts array[object] - Preferences and settings for physical ports.
operation object - Port operational status.
account object - Port owner account information.
changeLog object - A permanent record of asset creation, modification, or deletion.
location
href string https://api.equinix.com/fabric/v4/metros/AT An absolute URL that returns the specified asset.
ibx string AT1 Alphanumeric identifier assigned to an Equinix International Business Exchange (IBX) data center in which a specified asset is located.
metroCode string AT Metropolitan area identifier.
metroName string Atlanta Metropolitan area name.
region string AMER Broad geographic area in which a specified Equinix asset is located:
  • AMER — The Americas
  • APAC — Asia-Pacific)
  • EMEA — Europe, the Middle East, and Africa
project
projectId string 377533000114703 Customer project identifier.
device
name string dev-m7a2.lab Equinix-assigned device identifier.
redundancy object - Port redundancy configuration.
device.redundancy
priority string Secondary Relative priority in the redundancy group.
encapsulation
type string DOT1Q Encapsulation protocol.
tagProtocolId string 0x8100 Tagging protocol identifier.
  • 0x8100 - DOT1Q
  • 0x9100 - QINQ
lag
id string 108608 Link aggregation group (LAG) ID.
enabled boolean true Indicator showing if port is LAG enabled. The default value is false.
name string ae-108608 LAG name.
settings
buyout boolean false Buyout (true) or standard port configuration. Buyout ports offer free unlimited connections. Standard ports (false) do not. The default value is false.
placeVcOrderPermission boolean true Permission to order a virtual connection. The default value is false.
viewPortPermission boolean true Indicates if the user can see the port. The default value is false.
physicalPorts
uuid string dfd8884bb-4f65-4ab3-8f77-500dec2f87777 Unique Id of the switch port.
state string PROVISIONED Port availability.
type string XF_PHYSICAL_PORT Physical port type.
id integer 6967 Physical port identifier.
bandwidth integer 10000 Data transfer capacity (Mbps).
tether object - Equinix-side physical port connector information.
demarcationPoint object - Customer-side physical port connector information.
settings object - Physical port specifications.
operation object - Operational data for a specified port.
physicalPorts.tether
crossConnectId string 100179-A Cross-connection identifier.
cabinetNumber string Demarc Cabinet name.
systemName string GV1:01:001032 Colocation cage identifier.
patchPanelName string PP:956:66107 Name of the patch panel where the given port is located.
patchPanelPortA string 5 ID for the origin of a cross-connect port interface.
patchPanelPortB string 42 ID for the destination side of a cross-connect port interface.
physicalPorts.demarcationPoint
patchPanelName string PP:956:66107 Name of the patch panel where the given port is located.
patchPanelPortA string 5 ID for the origin of a cross-connect port interface.
patchPanelPortB string 42 ID for the destination side of a cross-connect port interface.
ibx string DC6 Identifier of the IBX data center where the given physical port is located.
physicalPorts.settings
sharedPortType boolean false Type of shared port. A shared port is a single physical port that handles multiple virtual connections.
sharedPortProduct string NA Name of the Equinix product associated with the shared port.
physicalPorts.operation
operationalStatus string UP Availability of a given physical port.
operation
operationalStatus string UP Availability of a given port.
opStatusChangedAt string 2021-08-14T19:30:29.526Z Date and time at which port availability changed in IETF ISO 8601 extended date/time format:
YYYY-MM-DDTHH:MM:SS.000+0000 or
YYYY-MM-DDTHH:MM:SSZ.
connectionCount integer 0 Total number of connections established using this port.
acount
accountNumber integer 100179 Equinix-assigned account number.
accountName string L2 Legal name of the accountholder.
globalCustId string 007700000090982RG8 Equinix-assigned ID of the subscriber's parent organization.
orgId string 100179 Equinix-assigned ID of the subscriber's organization.
organizationName string Cust_Org_100179 Equinix-assigned name of the subscriber's organization.
changeLog
createdDateTime string 2021-08-14T19:30:29.526Z Asset creation timestamp in IETF ISO 8601 extended date/time format:
YYYY-MM-DDTHH:MM:SS.000+0000 or
YYYY-MM-DDTHH:MM:SSZ.

If you get an "Access Denied" error, contact your local Equinix Service Desk for help.

Get Specified Port

GET /fabric/v4/ports/{portUuid}
Method GET
URL or Endpoint /fabric/v4/ports/{portUuid}
Headers Authorization
Path Parameters uuid
Query Parameters Not applicable
Body Parameters Not applicable

This API request returns details for the specified port.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.


Sample curl request

Copy 
curl -X GET 'https://api.equinix.com/fabric/v4/ports/13c0f286-1190-480c-8a45-b3df00cad9cf'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Path parameters

Parameter Mandatory Type Example Applicable Values Description
uuid no string e91484bb-4f65-4ab3-8f77-500dec2f855d - Equinix-assigned port identifier.

Sample response

Copy 
{
    "href": "https://api.equinix.com/fabric/v4/ports/cecd1039-eadd-add3-31e0-387a5c00aeb9",
    "type": "XF_PORT",
    "uuid": "cecd1039-eadd-add3-31e0-387a5c00aeb9",
    "name": "testBuyer-DC6-NL-Qinq-STD-SEC-10G-JUN-2",
    "physicalPortsSpeed": 1000,
    "connectivitySourceType": "COLO",
    "physicalPortsType",: "1000BASE_LX",
    "state": "ACTIVE",
    "cvpId": "1617846",
    "bandwidth": 10000,
    "usedBandwidth": 3596,
    "availableBandwidth": 6403,
    "location": {
        "href": "https://api.equinix.com/fabric/v4/metros/DC",
        "ibx": "DC6",
        "metroCode": "DC",
        "metroName": "Ashburn",
        "region": "AMER"
    },
    "project": {
        "projectId": "1234567"
    },

    "device": {
        "name": "qa3-dc-a2.lab",
        "redundancy": {
            "priority": "SECONDARY"
        }
    },
    "encapsulation": {
        "type": "QINQ",
        "tagProtocolId": "0x9100"
    },
    "lag": {
        "enabled": false
    },
    "settings": {
        "buyout": false,
        "placeVcOrderPermission": true,
        "viewPortPermission": true
    },
    "physicalPorts": [
        {
            "uuid": "dfd8884bb-4f65-4ab3-8f77-500dec2f87777",
            "state": "ACTIVE",
            "type": "XF_PHYSICAL_PORT",
            "id": 1426505,
            "bandwidth": 10000,
            "tether": {
                "crossConnectId": "21864962",
                "cabinetNumber": "Demarc",
                "systemName": "DC6:01:001285",
                "patchPanelName": "CP:Demarc:1258531",
                "patchPanelPortA": "1",
                "patchPanelPortB": "2"
            },
            "demarcationPoint": {
                "patchPanelName": "CP:Demarc:1258533",
                "patchPanelPortA": "3",
                "patchPanelPortB": "4",
                "ibx": "DC6"
            },
            "settings": {
                "sharedPortType": false,
                "sharedPortProduct": "NA"
            },
            "operation": {
                "operationalStatus": "UP",
                "opStatusChangedAt": "2021-12-02T00:00:00Z"
            }
        }
    ],
    "operation": {
        "operationalStatus": "UP",
        "opStatusChangedAt": "2021-10-20T17:25:24Z",
        "connectionCount": 30,
        "evplVCCount": 30,
        "fgVCCount": 0,
        "accessVCCount": 0
    },
    "account": {
        "accountNumber": 270001,
        "accountName": "testBuyer",
        "ucmId": "08374E19-9B56-4c27-84BA-33D42BB0940C",
        "globalCustId": "0016u000003JZ4sAAG",
        "orgId": "91997",
        "organizationName": "testBuyer-270001"
    },
    "changeLog": {
        "updatedDateTime": "2021-10-20T17:25:24Z",
        "createdDateTime": "2021-10-20T17:25:24Z"
    }
}

Use the Metros API to create a list of all metros your account can connect to.


Response payload body description

Parameter Type Example Description
href string https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d An absolute URL that returns the specified asset.
type string XF_PORT Type of port.
uuid string e91484bb-4f65-4ab3-8f77-500dec2f855d Equinix-assigned port identifier.
name string AT1-Dot1q-L-Secondary-108608 Port name.
physicalPortsSpeed integer 0 Physical ports speed in Mbps.
physicalPortsType string 1000BASE_LX

Physical ports type.

  • 1000BASE_LX

  • 10GBASE_LR

  • 100GBASE_LR4

  • 10GBASE_ER

  • 1000BASE_SX
connectivitySourceType string COLO

Port connectivity type.

  • COLO

  • BMMR

  • REMOTE
state string ACTIVE Port lifecycle status.
cvpId string 108608 CloudVision Portal port identifier.
bandwidth integer 1000 Data transfer capacity (Mbps).
usedBandwidth integer 0 Port bandwidth consumed (Mbps).
availableBandwidth integer 1000 Remaining port bandwidth (Mbps).
location object - Geographic attributes of the specified access point.
project object - Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
device object - Device configuration settings.
encapsulation object - Encapsulation specification.
lag object - Link aggregation group (LAG) configuration.
settings object - Port configuration settings.
physicalPorts array[object] - Preferences and settings for physical ports.
operation object - Port operational status.
account object - Port owner account information.
changeLog object - A permanent record of asset creation, modification, or deletion.
location
href string https://api.equinix.com/fabric/v4/metros/AT An absolute URL that returns the specified asset.
ibx string AT1 Alphanumeric identifier assigned to an Equinix International Business Exchange (IBX) data center in which a specified asset is located.
metroCode string AT Metropolitan area identifier.
metroName string Atlanta Metropolitan area name.
region string AMER Broad geographic area in which a specified Equinix asset is located:
  • AMER — The Americas
  • APAC — Asia-Pacific)
  • EMEA — Europe, the Middle East, and Africa
project
projectId string 377533000114703 Customer project identifier.
device
name string dev-m7a2.lab Equinix-assigned device identifier.
redundancy object - Port redundancy configuration.
device.redundancy
priority string Secondary Relative priority in the redundancy group.
encapsulation
type string DOT1Q Encapsulation protocol.
tagProtocolId string 0x8100 Tagging protocol identifier.
  • 0x8100 - DOT1Q
  • 0x9100 - QINQ
lag
id string 108608 Link aggregation group (LAG) ID.
enabled boolean true Indicator showing if port is LAG enabled. The default value is false.
name string ae-108608 LAG name.
settings
buyout boolean false Buyout (true) or standard port configuration. Buyout ports offer free unlimited connections. Standard ports (false) do not. The default value is false.
placeVcOrderPermission boolean true Permission to order a virtual connection. The default value is false.
viewPortPermission boolean true Indicates if the user can see the port. The default value is false.
physicalPorts
uuid string dfd8884bb-4f65-4ab3-8f77-500dec2f87777 Unique Id of the switch port.
state string PROVISIONED Port availability.
type string XF_PHYSICAL_PORT Physical port type.
id integer 6967 Physical port identifier.
bandwidth integer 10000 Data transfer capacity (Mbps).
tether object - Equinix-side physical port connector information.
demarcationPoint object - Customer-side physical port connector information.
settings object - Physical port specifications.
operation object - Operational data for a specified port.
physicalPorts.tether
crossConnectId string 100179-A Cross-connection identifier.
cabinetNumber string Demarc Cabinet name.
systemName string GV1:01:001032 Colocation cage identifier.
patchPanelName string PP:956:66107 Name of the patch panel where the given port is located.
patchPanelPortA string 5 ID for the origin of a cross-connect port interface.
patchPanelPortB string 42 ID for the destination side of a cross-connect port interface.
physicalPorts.demarcationPoint
patchPanelName string PP:956:66107 Name of the patch panel where the given port is located.
patchPanelPortA string 5 ID for the origin of a cross-connect port interface.
patchPanelPortB string 42 ID for the destination side of a cross-connect port interface.
ibx string DC6 Identifier of the IBX data center where the given physical port is located.
physicalPorts.settings
sharedPortType boolean false Type of shared port. A shared port is a single physical port that handles multiple virtual connections.
sharedPortProduct string NA Name of the Equinix product associated with the shared port.
physicalPorts.operation
operationalStatus string UP Availability of a given physical port.
operation
operationalStatus string UP Availability of a given port.
opStatusChangedAt string 2021-08-14T19:30:29.526Z Date and time at which port availability changed in IETF ISO 8601 extended date/time format:
YYYY-MM-DDTHH:MM:SS.000+0000 or
YYYY-MM-DDTHH:MM:SSZ.
connectionCount integer 0 Total number of connections established using this port.
acount
accountNumber integer 100179 Equinix-assigned account number.
accountName string L2 Legal name of the accountholder.
globalCustId string 007700000090982RG8 Equinix-assigned ID of the subscriber's parent organization.
orgId string 100179 Equinix-assigned ID of the subscriber's organization.
organizationName string Cust_Org_100179 Equinix-assigned name of the subscriber's organization.
changeLog
createdDateTime string 2021-08-14T19:30:29.526Z Asset creation timestamp in IETF ISO 8601 extended date/time format:
YYYY-MM-DDTHH:MM:SS.000+0000 or
YYYY-MM-DDTHH:MM:SSZ.

If you get an "Access Denied" error, please contact your local Equinix Service Desk for help.

Delete Specified Port

DELETE /fabric/v4/ports/{portUuid}
Method DELETE
URL or Endpoint /fabric/v4/ports/{portUuid}
Headers Authorization
Path Parameters uuid
Query Parameters Not applicable
Body Parameters Not applicable

Deletes a port.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.


Sample curl request

Copy 
curl -X DELETE 'https://api.equinix.com/fabric/v4/ports/13c0f286-1190-480c-8a45-b3df00cad9cf'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Path parameters

Parameter
Description
portUuid string
REQUIRED		 Unique Id of a port.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Sample response

Copy 
{
"href": "https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d",
"type": "XF_PORT",
"uuid": "e91484bb-4f65-4ab3-8f77-500dec2f855d",
"name": "test-AT1-Dot1q-L-Secondary-108608",
"state": "DEPROVISIONING",
"bandwidth": 10000,
"usedBandwidth": 0,
"availableBandwidth": 20000,
"redundancy": {
    "group": "C91484bb-4f65-4ab3-8f77-500dec2f855C",
    "priority": "PRIMARY"
},
"location": {
    "metroHref": "https://api.equinix.com/fabric/v4/metros/AT",
    "ibx": "AT1",
    "metroCode": "AT",
    "metroName": "Atlanta",
    "region": "AMER"
},
"device": {
    "name": "dev-m7a2.lab",
    "redundancy": {
    "group": "C91484bb-4f65-4ab3-8f77-500dec2f855C",
    "priority": "PRIMARY"
    }
},
"encapsulation": {
    "type": "DOT1Q",
    "tagProtocolId": 33024
},
"lagEnabled": true,
"lag": {
    "enabled": true
},
"settings": {
    "buyout": false,
    "placeVcOrderPermission": true,
    "viewPortPermission": true
},
"physicalPorts": [
    {
    "state": "DEPROVISIONING",
    "type": "XF_PHYSICAL_PORT",
    "bandwidth": 10000,
    "tether": {
        "crossConnectId": "100179-A",
        "patchPanel": "PP:8118:1586",
        "patchPanelPortA": "92",
        "patchPanelPortB": "24"
    },
    "demarcationPoint": {
        "ibx": "AT1",
        "patchPanel": "PP:8118:1586",
        "patchPanelName": "PP:8118:1586",
        "patchPanelPortA": "92",
        "patchPanelPortB": "24"
    }
    }
],
"account": {
    "accountNumber": 100179,
    "accountName": "L2 account",
    "globalCustId": "007700000090982RG8",
    "orgId": 100179,
    "organizationName": "Cust_Org_100179"
},
"changeLog": {
    "createdDateTime": "2018-06-14T17:21:25.587Z"
}
}

Response payload body description

For a detailed description of the response, refer to the response of Get Specified Port.

Get Used Vlans

GET /fabric/v4/ports/{portUuid}/linkProtocols
Method GET
URL or Endpoint /fabric/v4/ports/{portUuid}/linkProtocols
Headers Authorization
Path Parameters uuid
Query Parameters offset, limit
Body Parameters Not applicable

This API returns used Vlans for a specified port.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.


Sample curl request

Copy 
curl -X GET 'https://api.equinix.com/fabric/v4/ports/13c0f286-1190-480c-8a45-b3df00cad9cf/linkProtocols'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Path parameters

Parameter Mandatory Type Example Applicable Values Description
uuid no string e91484bb-4f65-4ab3-8f77-500dec2f855d - Equinix-assigned port identifier.

Sample response

Copy 
{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 3
    },
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/ports/637bb50e-3f3c-4587-972d-540a1e8a27ca/linkProtocols?offset=0&limit=20",
            "uuid": "fcd4ffdf-d4ef-45c8-9a83-7389d4912695",
            "state": "RESERVED",
            "type": "DOT1Q",
            "vlanSTag": 2288,
            "connection": {
                "uuid": "9624b2bf-dd4c-40f2-9a13-72c7601b1d8a",
                "bandwidth": 50000000
            },
            "changeLog": {
                "createdDateTime": "2023-01-19T23:03:47.192Z"
            }
        },
        {
            "href": "https://api.equinix.com/fabric/v4/ports/637bb50e-3f3c-4587-972d-540a1e8a27ca/linkProtocols?offset=0&limit=20",
            "uuid": "6648145c-01e9-4437-b6f7-5dab4a2c8a8d",
            "state": "RESERVED",
            "type": "DOT1Q",
            "vlanTagMin": 0,
            "vlanTagMax": 0,
            "vlanSTag": 588,
            "vlanCTagMin": 0,
            "vlanCTagMax": 0,
            "serviceToken": {
                "uuid": "f6e45f4c-71df-4640-b344-21db9343562f",
                "bandwidth": 50000000
            },
            "changeLog": {
                "createdDateTime": "2023-03-06T23:09:13.249Z"
            }
        },
        {
            "href": "https://api.equinix.com/fabric/v4/ports/637bb50e-3f3c-4587-972d-540a1e8a27ca/linkProtocols?offset=0&limit=20",
            "uuid": "da4711ee-63a4-4eb4-9f0d-861313e2c247",
            "state": "RESERVED",
            "type": "DOT1Q",
            "vlanTagMin": 0,
            "vlanTagMax": 0,
            "vlanSTag": 663,
            "vlanCTagMin": 0,
            "vlanCTagMax": 0,
            "connection": {
                "uuid": "7f32f834-24f8-460f-a704-bd27b3dff9af",
                "bandwidth": 5000000
            },
            "changeLog": {
                "createdDateTime": "2023-03-08T16:56:28.093Z"
            }
        }
    ]
}

Use the Metros API to create a list of all metros your account can connect to.


Response payload body description

Parameter Type Example Description
pagination object - Search results pagination settings.
data array[object] - Data array containing returned objects.
pagination
offset integer ?offset=0 Index of the first item returned in the response. The value must be >=0, and the default is 0.
limit integer ?limit=10 Maximum number of items returned per page. Number must be between 1 and 1000, and the default is 999.
total integer 1 Total number of items returned.
data
href string https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d An absolute URL that returns the specified asset.
uuid string e91484bb-4f65-4ab3-8f77-500dec2f855d Equinix-assigned port identifier.
state string RESERVED Whether the port is RESERVED or not.
type string DOT1Q Type.
vlanSTag integer 588 QINQ protocol outer (service) VLAN tag used to identify packets as they traverse trunk lines.
vlanCTag integer 588 QINQ protocol inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
vlanCTagMin integer 0 QINQ protocol lowest customer VLAN tag value.
vlanCTagMax integer 0 QINQ protocol highest customer VLAN tag value.
vlanTagMin integer 0 DOT1Q protocol VLAN tag range lowest value.
vlanTagMax integer 0 DOT1Q protocol VLAN tag range highest value.
serviceToken object - An object that has the details of the service token.
connection object - An object that has the details of the connection.
changeLog object - A permanent record of asset creation, modification, or deletion.
serviceToken
uuid string e91484bb-4f65-4ab3-8f77-500dec2f855d Equinix-assigned service token identifier.
bandwidth integer 1000000 Bandwidth.
connection
uuid string e91484bb-4f65-4ab3-8f77-500dec2f855d Equinix-assigned connection identifier.
bandwidth integer 1000000 Bandwidth.
changeLog
createdBy string _system Created by
createdDateTime string 2021-08-14T19:30:29.526Z Asset creation timestamp in IETF ISO 8601 extended date/time format:
YYYY-MM-DDTHH:MM:SS.000+0000 or
YYYY-MM-DDTHH:MM:SSZ.
updatedDateTime string 2021-08-14T19:30:29.526Z Asset creation timestamp in IETF ISO 8601 extended date/time format:
YYYY-MM-DDTHH:MM:SS.000+0000 or
YYYY-MM-DDTHH:MM:SSZ.

If you get an "Access Denied" error, please contact your local Equinix Service Desk for help.

Search Ports

POST /fabric/v4/ports/search
Method POST
URL or Endpoint /fabric/v4/ports/search
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters filter

Search for ports.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.


Sample curl request

Copy 
curl -X POST 'http://api.equinix.com/fabric/v4/ports/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "filter": {
    "or": [
        {
        "and": [
            {
            "operator": "=",
            "property": "/project/projectId",
            "values": [
                "30ad25e2-53dc-11ed-bdc3-0242ac120002"
            ]
            },
            {
            "operator": "=",
            "property": "/state",
            "values": [
                "ACTIVE"
            ]
            },
            {
            "operator": "=",
            "property": "/settings/productCode",
            "values": [
                "CX"
            ]
            }
        ]
        }
    ]
    },
    "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 0
    },
    "sort": [
    {
        "property": "/device/name",
        "direction": "DESC"
    }
    ]
}'

Body parameters

Parameter
Description
filter object
REQUIRED
 Object containing filtering criteria to search for ports.
or array[object]
REQUIRED
 Array of criteria joined by the "or" operator.
and array[object]
REQUIRED
 Array of criteria joined by the "and" operator.
property string
REQUIRED
 Search for ports based on filtering criteria.
Applicable values:
  • /project/projectId
  • /state
  • /settings/productCode
operator string
REQUIRED
 Parameter operator.
Applicable values:
  • =
values string
REQUIRED
 Parameter value.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
/project/projectId Example:
"property": "/project/projectId",
"operator": "=",
"values": [
"xx-xx-xx"
]
operator string
REQUIRED
 Search field operator.
Applicable values:
  • =
value array[string]
REQUIRED
 Connection name.
Example: ["xx-xx-xx"]
/state Example:
"property": "/state",
"operator": "=",
"values": [
"ACTIVE
]
operator string
REQUIRED
 Search field operator.
Applicable values:
  • =
value array[string]
REQUIRED
 State of the port.
Example: ["ACTIVE"]
/settings/productCode Example:
"property": "/settings/productCode",
"operator": "=",
"values": [
"CX"
]
operator string
REQUIRED
 Search field operator.
Applicable values:
  • =
value array[string]
REQUIRED
 Search by the state of ports.
Example: ["CX"]

Sample response - ports

Copy 
{
    "pagination": {
        "offset": 0,
        "limit": 999,
        "total": 133
    },
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-599b-99b0-8ce0-306a5c00a4ee",
            "type": "XF_PORT",
            "uuid": "c791f8cb-599b-99b0-8ce0-306a5c00a4ee",
            "name": "testBuyer-DC5-NL-Dot1q-BO-PRI-10G-JN-163",
            "physicalPortsSpeed": 1000,
            "connectivitySourceType": "COLO",
            "physicalPortsType",: "1000BASE_LX",
            "state": "ACTIVE",
            "cvpId": "1614613",
            "bandwidth": 10000,
            "usedBandwidth": 6165,
            "availableBandwidth": 3835,
            "location": {
                "href": "https://api.equinix.com/fabric/v4/metros/DC",
                "ibx": "DC5",
                "metroCode": "DC",
                "metroName": "Ashburn",
                "region": "AMER"
            },
            "project": {
                "projectId": "1234567"
            },

            "device": {
                "name": "qa3-dc-a1.lab",
                "redundancy": {
                    "priority": "PRIMARY"
                }
            },
            "encapsulation": {
                "type": "DOT1Q",
                "tagProtocolId": "0x8100"
            },
            "lag": {
                "enabled": false
            },
            "settings": {
                "buyout": true,
                "placeVcOrderPermission": true,
                "viewPortPermission": true
            },
            "physicalPorts": [
                {
                    "state": "ACTIVE",
                    "type": "XF_PHYSICAL_PORT",
                    "id": 1426515,
                    "bandwidth": 10000,
                    "tether": {
                        "crossConnectId": "ECX.01.00002995",
                        "cabinetNumber": "Demarc",
                        "systemName": "DC5:01:001015",
                        "patchPanelName": "PP:Demarc:00001016",
                        "patchPanelPortA": "1",
                        "patchPanelPortB": "2",
                    },
                    "demarcationPoint": {
                        "patchPanelName": "PP:Demarc:00001015",
                        "patchPanelPortA": "5",
                        "patchPanelPortB": "6",
                        "ibx": "DC5"
                    },
                    "settings": {
                        "sharedPortType": false,
                        "sharedPortProduct": "NA"
                    },
                    "operation": {
                        "operationalStatus": "UP",
                        "opStatusChangedAt": "2021-12-02T00:00:00Z"
                    }
                }
            ],
            "operation": {
                "operationalStatus": "UP",
                "opStatusChangedAt": "2021-07-20T17:04:18Z",
                "connectionCount": 53,
                "evplVCCount": 53,
                "fgVCCount": 0,
                "accessVCCount": 0
            },
            "account": {
                "accountNumber": 270001,
                "accountName": "testBuyer",
                "ucmId": "08374E19-9B56-4c27-84BA-33D42BB0940C",
                "globalCustId": "0016u000003JZ4sAAG",
                "orgId": "91997",
                "organizationName": "testBuyer-270001"
            },
            "changeLog": {
                "updatedDateTime": "2021-07-20T17:04:18Z",
                "createdDateTime": "2021-07-20T17:04:18Z"
            }
        }
    ]
}

Response payload body description

Parameter Data Type Example Values Description
pagination object - Search results pagination settings.
data array[object] - Data array containing returned objects.
pagination
offset integer ?offset=0 Index of the first item returned in the response. The value must be >=0, and the default is 0.
limit integer ?limit=10 Maximum number of items returned per page. Number must be between 1 and 1000, and the default is 999.
total integer 1 Total number of items returned.
data
href string https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d An absolute URL that returns the specified asset.
type string XF_PORT Type of port.
uuid string e91484bb-4f65-4ab3-8f77-500dec2f855d Equinix-assigned port identifier.
name string AT1-Dot1q-L-Secondary-108608 Port name.
physicalPortsSpeed integer 0 Physical ports speed in Mbps.
physicalPortsType string 1000BASE_LX

Physical ports type.

  • 1000BASE_LX

  • 10GBASE_LR

  • 100GBASE_LR4

  • 10GBASE_ER

  • 1000BASE_SX
connectivitySourceType string COLO

Port connectivity type.

  • COLO

  • BMMR

  • REMOTE
state string ACTIVE Port lifecycle status.
cvpId string 108608 CloudVision Portal port identifier.
bandwidth integer 1000 Data transfer capacity (Mbps).
usedBandwidth integer 0 Port bandwidth consumed (Mbps).
availableBandwidth integer 1000 Remaining port bandwidth (Mbps).
location object - Geographic attributes of the specified access point.
project object - Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
device object - Device configuration settings.
encapsulation object - Encapsulation specification.
lag object - Link aggregation group (LAG) configuration.
settings object - Port configuration settings.
physicalPorts array[object] - Preferences and settings for physical ports.
operation object - Port operational status.
account object - Port owner account information.
changeLog object - A permanent record of asset creation, modification, or deletion.
location
href string https://api.equinix.com/fabric/v4/metros/AT An absolute URL that returns the specified asset.
ibx string AT1 Alphanumeric identifier assigned to an Equinix International Business Exchange (IBX) data center in which a specified asset is located.
metroCode string AT Metropolitan area identifier.
metroName string Atlanta Metropolitan area name.
region string AMER Broad geographic area in which a specified Equinix asset is located:
  • AMER — The Americas
  • APAC — Asia-Pacific)
  • EMEA — Europe, the Middle East, and Africa
project
projectId string 377533000114703 Customer project identifier.
device
name string dev-m7a2.lab Equinix-assigned device identifier.
redundancy object - Port redundancy configuration.
device.redundancy
priority string Secondary Relative priority in the redundancy group.
encapsulation
type string DOT1Q Encapsulation protocol.
tagProtocolId string 0x8100 Tagging protocol identifier.
  • 0x8100 - DOT1Q
  • 0x9100 - QINQ
lag
id string 108608 Link aggregation group (LAG) ID.
enabled boolean true Indicator showing if port is LAG enabled. The default value is false.
name string ae-108608 LAG name.
settings
buyout boolean false Buyout (true) or standard port configuration. Buyout ports offer free unlimited connections. Standard ports (false) do not. The default value is false.
placeVcOrderPermission boolean true Permission to order a virtual connection. The default value is false.
viewPortPermission boolean true Indicates if the user can see the port. The default value is false.
physicalPorts
state string PROVISIONED Port availability.
type string XF_PHYSICAL_PORT Physical port type.
id integer 6967 Physical port identifier.
bandwidth integer 10000 Data transfer capacity (Mbps).
tether object - Equinix-side physical port connector information.
demarcationPoint object - Customer-side physical port connector information.
settings object - Physical port specifications.
operation object - Operational data for a specified port.
physicalPorts.tether
crossConnectId string 100179-A Cross-connection identifier.
cabinetNumber string Demarc Cabinet name.
systemName string GV1:01:001032 Colocation cage identifier.
patchPanelName string PP:956:66107 Name of the patch panel where the given port is located.
patchPanelPortA string 5 ID for the origin of a cross-connect port interface.
patchPanelPortB string 42 ID for the destination side of a cross-connect port interface.
physicalPorts.demarcationPoint
patchPanelName string PP:956:66107 Name of the patch panel where the given port is located.
patchPanelPortA string 5 ID for the origin of a cross-connect port interface.
patchPanelPortB string 42 ID for the destination side of a cross-connect port interface.
ibx string DC6 Identifier of the IBX data center where the given physical port is located.
physicalPorts.settings
sharedPortType boolean false Type of shared port. A shared port is a single physical port that handles multiple virtual connections.
sharedPortProduct string NA Name of the Equinix product associated with the shared port.
physicalPorts.operation
operationalStatus string UP Availability of a given physical port.
operation
operationalStatus string UP Availability of a given port.
opStatusChangedAt string 2021-08-14T19:30:29.526Z Date and time at which port availability changed in IETF ISO 8601 extended date/time format:
YYYY-MM-DDTHH:MM:SS.000+0000 or
YYYY-MM-DDTHH:MM:SSZ.
connectionCount integer 0 Total number of connections established using this port.
acount
accountNumber integer 100179 Equinix-assigned account number.
accountName string L2 Legal name of the accountholder.
globalCustId string 007700000090982RG8 Equinix-assigned ID of the subscriber's parent organization.
orgId string 100179 Equinix-assigned ID of the subscriber's organization.
organizationName string Cust_Org_100179 Equinix-assigned name of the subscriber's organization.
changeLog
createdDateTime string 2021-08-14T19:30:29.526Z Asset creation timestamp in IETF ISO 8601 extended date/time format:
YYYY-MM-DDTHH:MM:SS.000+0000 or
YYYY-MM-DDTHH:MM:SSZ.

If you get an "Access Denied" error, contact your local Equinix Service Desk for help.