Skip to main content

Get All Ports - Parameters Mapping

This API returns a data set with all user-provisioned ports.

v3 request
curl -X
GET 'https://api.equinix.com/ecx/v3/port/userport'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
v4 request
curl -X
GET 'https://api.equinix.com/fabric/v4/ports'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

v3 API requestv4 API requestDescription
GET /ecx/v3/port/userportGET /fabric/v4/portsRequest: -

Response: v3 and v4 port objects have different structure and parameters' names.

Response

v3 request
[
    {
        "uuid": "9a1b30c7-baaf-aaf0-96e0-30ac188c7099",
        "name": "johnDoePort",
        "provisionStatus": "ADDED",
        "region": "AMER",
        "device": "1C00A955256C0027A0D544A68EE8C911",
        "totalBandwidth": 1000000000,
        "buyout": true,
        "custOrgId": "99966",
        "ibx": "SV1",
        "metroCode": "SV",
        "metroDescription": "Silicon Valley",
        "deviceGroup": "2",
        "devicePriority": "Primary",
        "encapsulation": "Dot1q",
        "viewPortPermission": true,
        "placeVcOrderPermission": true,
        "createdDate": "2018-11-07 21:56:59.0",
        "lastUpdatedDate": "2018-11-07 21:56:59.0",
        "userPorts": [
            {
                "bandwidth": 1000000000,
                "crossConnectId": "20883104"
            }
        ],
        "layer3Enabled": true,
        "lag": false
    }
]
v4 request
{
    "pagination": {
        "offset": 0,
        "limit": 999,
        "total": 134
    },
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-59c8-9c80-8ce0-306a5c00a4ee",
            "type": "XF_PORT",
            "uuid": "c791f8cb-59c8-9c80-8ce0-306a5c00a4ee",
            "name": "testBuyer-DC6-NL-Dot1q-STD-SEC-10G-JN-208",
            "state": "ACTIVE",
            "cvpId": "1614658",
            "bandwidth": 10000,
            "usedBandwidth": 6701,
            "availableBandwidth": 3299,
            "location": {
                "href": "https://api.equinix.com/fabric/v4/metros/DC",
                "ibx": "DC6",
                "metroCode": "DC",
                "metroName": "Ashburn",
                "region": "AMER"
            },
            "device": {
                "name": "qa3-dc-a2.lab",
                "redundancy": {
                    "priority": "SECONDARY"
                }
            },
            "encapsulation": {
                "type": "DOT1Q",
                "tagProtocolId": "0x8100"
            },
            "lag": {
                "enabled": false
            },
            "settings": {
                "buyout": false,
                "placeVcOrderPermission": true,
                "viewPortPermission": true
            },
            "physicalPorts": [
                {
                    "state": "ACTIVE",
                    "type": "XF_PHYSICAL_PORT",
                    "id": 1426489,
                    "bandwidth": 10000,
                    "tether": {
                        "crossConnectId": "ECX.01.00003040",
                        "cabinetNumber": "Demarc",
                        "systemName": "DC6:01:001001"
                    },
                    "settings": {
                        "sharedPortType": "NA",
                        "sharedPortProduct": "NA"
                    },
                    "operation": {
                        "operationalStatus": "UP",
                        "opStatusChangedAt": "2021-12-02T00:00:00Z"
                    }
                }
            ],
            "operation": {
                "operationalStatus": "UP",
                "opStatusChangedAt": "2021-07-20T17:05:46Z",
                "connectionCount": 51,
                "evplVCCount": 51,
                "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:05:46Z",
                "createdDateTime": "2021-07-20T17:05:46Z"
            }
        }
    ]
}

v3 parameterv4 parameterExampleDescription
-pagination-New container object for pagination parameters.
-pagination.offset200New parameter specifying the results page offset.
-pagination.limit100New parameter specifying the number of items returned on a single page.
-pagination.total1000New parameter specifying the total number of objects in the data set.
-hrefhttps://api.equinix.com/fabric/v4/ports/ c791f8cb-59c8-9c80-8ce0-306a5c00a4eeNew parameter specifying the absolute URL that returns details of the given asset.
-typeXF_PORTNew parameter specifying port type.
uuiduuidc791f8cb-59c8-9c80-8ce0-306a5c00a4eeEquinix-assigned port identifier.
namenameEquinix-EM-CX-xxx-L-Dot1q-BO-100G-PRI-xxPort name
provisionStatusstateACTIVEPort lifecycle stage. Note that v3 and v4 values for this parameter are different.
-cvpId1616246New parameter, unique identifier for a virtual port.
totalBandwidthbandwidth10000Data transfer capacity in Mbps (v4) or in bytes (v3).
-usedBandwidth1000New parameter, port bandwidth consumed (Mbps).
-availableBandwidth9000New parameter, remaining port bandwidth (Mbps).
-location-New container object for location information.
-location.hrefhttps://api.equinix.com/fabric/v4/metros/SYNew parameter specifying the absolute URL that returns details of the given asset.
ibxlocation.ibxSY1IBX data center identifier.
metroCodelocation.metroCodeSYMetropolitan area identifier.
metroDescriptionlocation.metroNameSydneyMetropolitan area name.
regionlocation.regionAPACBroad geographical region.
-device-New container object for device configuration settings.
devicedevice.nameqa2-gv-nk-e2.labEquinix-assigned device identifier.
-device.redundancy-Device redundancy configuration.
devicePrioritydevice.redundancy.priorityPRIMARYPort's realative priority in the redundancy group.
deviceGroupdevice.redundancy.group1Equinix-assigned redudancy group identifier.
-encapsulation-New container object for port encapsulation configuration.
encapsulationencapsulation.typeDOT1QPort encapsulation type.
-encapsulation.tagProtocolId0x8100New parameter, Port encapsulation tag protocol identifier.
-lag New container object for port link aggregation configuration.
laglag.enabledtrueIndicates if LAG is enabled.
-settings-New container object for port settings.
buyoutsettings.buyoutfalseBuyout (true) or standard port configuration. Buyout ports offer free unlimited connections. Standard ports (false) do not. The default value is false.
placeVcOrderPermissionsettings.placeVcOrderPermissiontruePermission to order a virtual connection. The default value is false.
viewPortPermissionsettings.viewPortPermissiontrueAuthorization to view port permissions. The default value is false.
userPortsphysicalPorts-Physical ports configuration.
-physicalPorts.statePROVISIONEDPort availability.
-physicalPorts.typeXF_PHYSICAL_PORTPhysical port type.
-physicalPorts.id6967Physical port identifier.
userPorts.bandwidthphysicalPorts.bandwidth10000Data transfer capacity from source to destination (Mbps).
-physicalPorts.tether-Specifications for a physical port connector.
userPorts.crossConnectIdphysicalPorts.tether.crossConnectId-Cross-connection identifier.
-physicalPorts.tether.cabinetNumberDemarcRack cabinet number where the tether is housed.
-physicalPorts.tether.systemNameDC6:01:001001Name of the system to which the tether belongs.
-physicalPorts.settings-Port settings
-physicalPorts.settings.sharedPortTypeNAType of shared port. A shared port is a single physical port that handles multiple virtual connections.
-physicalPorts.settings.sharedPortProductNAName of the Equinix product associated with the shared port.
-physicalPorts.operation-New container object for physical port's operational status information.
-physicalPorts.operation.operationalStatusUPPhysical port's operational status.
-physicalPorts.operation.opStatusChangedAt2021-12-02T00:00:00ZStatus change timestamp.
-operation-New container object for port's operational status information.
-operation.operationalStatusUPPort's operational status.
-operation.opStatusChangedAt2021-12-02T00:00:00ZStatus change timestamp.
-operation.connectionCount51Total number of connections served by the given port.
-operation.evplVCCount51Number of EVPL connections served by the given port.
-operation.fgVCCount0Number of Fabric Cloud Router connections served by the given port.
-operation.accessVCCount0Number of network access connections served by the given port.
custOrgId-99966The organization ID of the customer who owns the port.
layer3Enabled-trueIndicates whether the port is enabled for Layer 3 connections.
 account-New container object for billing account information.
-account.accountNumber270106Equinix-assigned account number.
 account.accountNametestBuyerAccount name.
-account.ucmId08374E19-9B56-4c27-84BA-33D42BB0940C 
-account.globalCustId0016u000003JZ4rAAGEquinix-assigned top-level customer identifier associated with the specified asset.
-account.orgId91996Equinix-assigned organization identifier.
-account.organizationNametestBuyer-270001Equinix-assigned organization name.
-changeLog-New container object for changelog information.
-changeLog.createdBytestBuyerStandardUserAllPermIdentity of the asset creator.
-changeLog.createdDate2022-02-09T05:12:33.078ZConnection creation timestamp in the IETF ISO 8601 extended date/time format:
YYYY-MM-DDTHH:MM:SS.000+0000