Creating Ports
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.
Create a Port
To create a port, send a POST request to the /fabric/v4/ports endpoint.
| 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 |
Sample cURL Request - colocation, non-LAG port:
curl -X POST 'https://api.equinix.com/fabric/v4/ports'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer <token>'
-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"
}
}
]
}'
Sample response:
{
"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"
}
}
]
}
For a detailed description of the response, or for more examples, see the API Reference.
Create a Pair of Redundant Ports
To create a pair of redundant ports, send a POST request to the /fabric/v4/ports/bulk endpoint.
| 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 |
Sample cURL Request - redundant, colocation, non-LAG ports:
curl -X POST 'https://api.equinix.com/fabric/v4/ports'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer <token>'
-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"
}
}
]
}
]
}'
Sample Response:
{
"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"
}
}
]
}
For a detailed description of the response, or for more examples, see the API Reference.