Get All Connections - Parameters Mapping
This API returns connections that match specified search criteria.
v3 request
curl -X
GET 'https://api.equinix.com/ecx/v3/l2/buyer/connections?metroCode=BL&status=PROVISIONED'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
v4 request
curl -X POST 'http: //api.equinix.com/fabric/v4/connections/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"filter": {
"and": [
{
"property": "/aSide/accessPoint/location/metroCode",
"operator": "=",
"values": [
"BL"
]
},
{
"property": "/operation/equinixStatus",
"operator": "=",
"values": [
"PROVISIONED"
]
}
]
},
"pagination": {
"limit": 25,
"offset": 0,
"total": 0
},
"sort": [
{
"property": "/name",
"direction": "DESC"
}
]
}'
curl -X
GET 'https://api.equinix.com/ecx/v3/l2/seller/connections?metroCode=BL&status=PROVISIONED'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
curl -X POST 'http: //api.equinix.com/fabric/v4/connections/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"filter": {
"and": [
{
"property": "/zSide/accessPoint/location/metroCode",
"operator": "=",
"values": [
"BL"
]
},
{
"property": "/operation/equinixStatus",
"operator": "=",
"values": [
"PROVISIONED"
]
}
]
},
"pagination": {
"limit": 25,
"offset": 0,
"total": 0
},
"sort": [
{
"property": "/name",
"direction": "DESC"
}
]
}'
| v3 API request | v4 API request | Description |
| GET /ecx/v3/l2/seller/connections GET /ecx/v3/l2/buyer/connections | POST /fabric/v4/connections/search | Request: v3 and v4 APIs use different HTTP methods. v4 APIs provides a single endpoint for seller and buyer connections. Search criteria in v3 can be provided as query parameters while in the v4, they are defined in the request body. The v4 API supports a greater variety of search parameters. Response: v3 and v4 connection objects have different structure and parameters' names. |
Response
v3 request
{
"isFirstPage": true,
"totalCount": 467,
"isLastPage": false,
"pageSize": 20,
"content": [
{
"buyerOrganizationName": "JOHN-DOE-ORG",
"uuid": "006d08e2-788e-4c83-82d3-07b1787644a5",
"name": "SAL-AZURE-TR-SEC-20",
"vlanSTag": 200,
"portUUID": "66284add-86d1-6d10-b4e0-30ac094f8af1",
"portName": "JOHN DOE TEST",
"asideEncapsulation": "dot1q",
"zsideEncapsulation": "dot1q",
"metroCode": "DC",
"metroDescription": "Ashburn",
"providerStatus": "DEPROVISIONED",
"status": "DEPROVISIONED",
"billingTier": "Up to 50 MB",
"speed": 50,
"speedUnit": "MB",
"redundancyType": "secondary",
"redundancyGroup": "8a8a10d9-956f-46ad-a510-ebeaf810fcdf",
"sellerMetroCode": "TR",
"sellerMetroDescription": "Toronto",
"sellerServiceName": "Azure Express Route",
"sellerServiceUUID": "a1390b22-bbe0-4e93-ad37-85beef9d254d",
"sellerOrganizationName": "John Doe Org",
"notifications": [
"JohnDoe@equinix.com"
],
"createdDate": "2018-08-30T04:20:36.033Z",
"createdBy": "JohnDoe@equinix.com",
"createdByFullName": "JohnDoe",
"createdByEmail": "JohnDoe@equinix.com",
"lastUpdatedBy": "JohnDoe",
"lastUpdatedDate": "2018-09-14T02:21:06.425Z",
"lastUpdatedByFullName": "JohnDoe",
"lastUpdatedByEmail": "JohnDoe@equinix.com",
"deletedBy": "JohnDoe@equinix.com",
"deletedDate": "2018-09-02T16:03:36.349Z",
"deletedByEmail": "JohnDoe@equinix.com",
"updateInProgress": false,
"zSidePortName": "John-Port",
"zSidePortUUID": "6f5680ea-1513-5130-50e0-30ac094f83ec",
"zSideVlanSTag": 8,
"remote": false,
"private": false,
"self": false
"redundantUUID": "79f53f74-31c9-4e77-a7f2-5fdb181a7e07"
}
],
"pageNumber": 0
}
v4 request
{
"pagination": {
"offset": 0,
"limit": 1000,
"total": 982
},
"sort": [
{
"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
],
"data": [
{
"type": "EVPL_VC",
"href": "https://api.equinix.com/fabric/v4/connections/46a80f90-ee3a-4470-bfb6-eeb0f01cf753",
"uuid": "46a80f90-ee3a-4470-bfb6-eeb0f01cf753",
"name": "SustainStandardConn",
"state": "PROVISIONED",
"operation": {
"providerStatus": "AVAILABLE",
"equinixStatus": "PROVISIONED"
},
"order": {
"purchaseOrderNumber": "PO344495943745"
},
"notifications": [
{
"type": "ALL",
"emails": [
"fake@mail.com"
]
}
],
"account": {
"accountNumber": 270106,
"orgId": 91996,
"globalOrgId": "0016u000003JZ4rAAG"
},
"changeLog": {
"createdBy": "testVerizon",
"createdDateTime": "2022-03-21T11:10:05.310Z",
"updatedBy": "testBuyerStandardUserAllPerm",
"updatedDateTime": "2022-03-21T11:10:06.222Z"
},
"bandwidth": 50,
"redundancy": {
"priority": "PRIMARY"
},
"isRemote": false,
"direction": "INCOMING",
"aSide": {
"accessPoint": {
"type": "COLO",
"account": {
"accountNumber": 270106,
"orgId": 91996,
"organizationName": "testGlobalcust-270100",
"globalOrgId": "0016u000003JZ4rAAG"
},
"location": {
"href": "https://api.equinix.com/fabric/v4/metros/BL",
"region": "EMEA",
"metroName": "Brussels",
"metroCode": "BL"
},
"port": {
"href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-5bf9-bf90-8ce0-306a5c00a4ee",
"uuid": "c791f8cb-5bf9-bf90-8ce0-306a5c00a4ee",
"name": "testGlobalcust-BL1-NL-Dot1q-STD-PRI-10G-JN-769"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 3087
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"account": {
"orgId": 91997,
"organizationName": "testBuyer-270001",
"globalOrgId": "0016u000003JZ4sAAG"
},
"location": {
"href": "https://api.equinix.com/fabric/v4/metros/BL",
"region": "EMEA",
"metroName": "Brussels",
"metroCode": "BL"
},
"port": {
"href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-5bd1-bd10-8ce0-306a5c00a4ee",
"uuid": "c791f8cb-5bd1-bd10-8ce0-306a5c00a4ee",
"name": "testBuyer-BL1-L-Dot1q-STD-PRI-10G-JN-729",
"redundancy": {
"priority": "PRIMARY"
}
},
"profile": {
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/73e92924-7ea7-4aff-9d2c-50d3faf6c792",
"type": "L2_PROFILE",
"name": "Sustain_Standard_USER_SP_L2_2",
"uuid": "73e92924-7ea7-4aff-9d2c-50d3faf6c792"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 3689
}
}
}
}
]
}
| v3 parameter | v4 parameter | Example | Description |
| isLastPage | - | true | Indicates the first page of results set. |
| isFirstPage | - | false | Indicates the last page of results set. |
| pageNumber | - | 222 | Results set page number. |
| - | pagination | - | New container object for pagination parameters. |
| - | pagination.offset | 200 | New parameter specifying the results page offset. |
| pageSize | pagination.limit | 100 | Number of items returned on a single page. |
| totalCount | pagination.total | 1000 | Total number of objects in the data set. |
| - | pagination.next | /search?offset=1000&limit=1000 | New parameter specyfing the next results page url. |
| - | pagination.previous | /search?offset=1000&limit=1000 | New parameter specyfing the previous results page url. |
| - | type | EVPL_VC | New parameter defining connection type, introduced to support new use cases. EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. |
| - | sort | - | New container object for sorting settings. |
| - | sort.direction | DESC | New parameter specifying the sorting direction. |
| - | sort.property | /changeLog/createdDateTime | New parameter specifying the property used for sorting the data set. |
| content | data | - | An array of connection objects. |
| For details on the remaining parameters mapping, refer to Get Specified Connection - Parameters Mapping. | |||