Getting Port Information
Prerequisites
Authenticate - Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication. Refer to API Authentication for instructions on how to call OAuth API to validate and authenticate your credentials.
Get All Ports
You can retrieve all the available ports for your user credentials by sending a GET request to the /fabric/v4/ports endpoint.
| Method | GET |
| URL or Endpoint | /fabric/v4/ports |
| Headers | Authorization |
| Path Parameters | Not applicable |
| Query Parameters | Not applicable |
| Body Parameters | Not applicable |
Sample cURL request:
curl -X GET 'https://api.equinix.com/fabric/v4/ports'
-H 'Authorization: Bearer <token>'
Sample Response:
{
"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"
}
}
]
}
For detailed descriptions of the response fields, see the API Reference.
Get the Details of a Port
To get the details of a port, send a GET request to the /fabric/v4/ports/{portUuid} endpoint, specifying the ID of the port in the path of the request.
| Method | GET |
| URL or Endpoint | /fabric/v4/ports/{portUuid} |
| Headers | Authorization |
| Path Parameters | uuid |
| Query Parameters | Not applicable |
| Body Parameters | Not applicable |
Sample cURL Request:
curl -X GET 'https://api.equinix.com/fabric/v4/ports/{port_id}'
-H 'Authorization: Bearer <token>'
Sample Response:
{
"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"
}
}
For detailed descriptions of the response fields, see the API Reference.
Get Used Vlans
To get a list of the used VLANs for a port, send a GET request to the /fabric/v4/ports/{portUuid}/linkProtocolsendpoint. Specify the port by ID in the path of the request.
| Method | GET |
| URL or Endpoint | /fabric/v4/ports/{portUuid}/linkProtocols |
| Headers | Authorization |
| Path Parameters | uuid |
| Query Parameters | offset, limit |
| Body Parameters | Not applicable |
Sample cURL request:
curl -X GET 'https://api.equinix.com/fabric/v4/ports/{port_id}/linkProtocols'
-H 'Authorization: Bearer <token>'
Sample Response:
{
"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"
}
}
]
}
For detailed descriptions of the response fields, see the API Reference.
Search for Ports
To search for the information on a port, send a POST request to the /fabric/v4/ports/search endpoint. Specify your search criteria using the parameters available in the body of the request.
| Method | POST |
| URL or Endpoint | /fabric/v4/ports/search |
| Headers | Authorization, Content-Type |
| Path Parameters | Not applicable |
| Query Parameters | Not applicable |
| Body Parameters | filter |
Sample cURL Request:
curl -X POST 'https://api.equinix.com/fabric/v4/ports/search'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-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"
}
]
}'
Notable Body Parameters:
| Parameter | Description |
|---|---|
filter objectREQUIRED | 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 stringREQUIRED | Search for ports based on filtering criteria.Applicable values: /project/projectId /state * /settings/productCode |
operator stringREQUIRED | Parameter operator.Applicable values: * = |
values stringREQUIRED | Parameter value.Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 |
| /project/projectId | Example: "property": "/project/projectId","operator": "=","values": [ "xx-xx-xx"] |
operator stringREQUIRED | Search field operator. Applicable values: * = |
value array[string]REQUIRED | Connection name.Example: ["xx-xx-xx"] |
| /state | Example: "property": "/state","operator": "=","values": [ "ACTIVE] |
operator stringREQUIRED | 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 stringREQUIRED | Search field operator. Applicable values: * = |
value array[string]REQUIRED | Search by the state of ports.Example: ["CX"] |
Sample Response:
{
"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"
}
}
]
}
For detailed descriptions of the response fields, see the API Reference.