Connections

Create Connection

POST /fabric/v4/connections
Method POST
URL or Endpoint /fabric/v4/connections
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters type, name, order, bandwidth, aSide, zSide, notifications

The POST Connections API request creates a layer 2 connection between two endpoints located in IBX data centers.


Sample curl request - non-redundant connection from a DOT1Q port to a QINQ port

Copy 
curl -X
                        POST 'https://api.equinix.com/fabric/v4/connections'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '{
                        "type": "EVPL_VC",
                        "name": "Conn-1",
                        "order": {
                        "purchaseOrderNumber": "1-129105284100"
                        },
                        "bandwidth": 1000,
                        "aSide": {
                        "accessPoint": {
                        "type": "COLO",
                        "port": {
                        "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
                        },
                        "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 1001
                        }
                        }
                        },
                        "zSide": {
                        "accessPoint": {
                        "type": "COLO",
                        "port": {
                        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
                        },
                        "linkProtocol": {
                        "type": "QINQ",
                        "vlanSTag": 2001,
                        "vlanCTag": 2002,
                        }
                        }
                        },
                        "project": {
                        "projectId": "1234567"
                        },
                        "notifications": [
                        {
                        "type": "ALL",
                        "emails": [
                        "test@equinix.com",
                        "test@equinix.com"
                        ]
                        }
                        ]
                    }'

Sample curl request - non-redundant connection to a QINQ port using an A-side service token

Copy 
curl -X
                        POST 'https://api.equinix.com/fabric/v4/connections'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '{
                        "type": "EVPL_VC",
                        "name": "My-Layer2-Connection-3",
                        "bandwidth": 1000,
                        "redundancy": {
                        "priority": "PRIMARY"
                        },
                        "aSide": {
                        "serviceToken": {
                        "uuid": "a00cef6f-8e35-4794-9ff9-665e084e4e6d"
                        }
                        },
                        "order": {
                        "purchaseOrderNumber": "po1234"
                        },
                        "zSide": {
                        "accessPoint": {
                        "type": "COLO",
                        "port": {
                        "uuid": "a00cef6f-8e35-4794-9ff9-665e084e4e6d"
                        },
                        "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 1001
                        }
                        }
                        },
                        "project": {
                        "projectId": "1234567"
                        },
                        "notifications": [
                        {
                        "type": "ALL",
                        "emails": [
                        "test@test.com"
                        ]
                        }
                        ]
                    }'

Sample curl request - Network Edge virtual device to DOT1Q port with VLAN range

Copy 
curl -X
                        POST 'https://api.equinix.com/fabric/v4/connections'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '{
                        "type": "EVPL_VC",
                        "bandwidth": 1000,
                        "name": "vd to COLO",
                        "aSide": {
                        "accessPoint": {
                        "type": "VD",
                        "virtualDevice": {
                        "type": "EDGE",
                        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
                        },
                        "interface": {
                        "type": "NETWORK",
                        "id": 45645
                        }
                        }
                        },
                        "zSide": {
                        "accessPoint": {
                        "type": "COLO",
                        "port": {
                        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
                        },
                        "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTagMin": 300,
                        "vlanTagMax": 1099
                        }
                        }
                        },
                        "order": {
                        "purchaseOrderNumber": "1-129105284100"
                        },
                        "project": {
                        "projectId": "1234567"
                        },
                        "notifications": [
                        {
                        "type": "ALL",
                        "emails": [
                        "test@equinix.com",
                        "test1@equinix.com"
                        ]
                        }
                        ]
                    }'

Body parameters

Parameter
Description
type string
REQUIRED
 Connection type.
Applicable values:
  • EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections.
  • EPL_VC - Ethernet private line connection type used for untagged layer 2 connections.
  • ACCESS_EPL_VC - E-access, layer 2 connection between a QINQ port and an EPL port.
  • IP_VC - Layer 2 connection between a Fabric Cloud Router instance and a port.
  • EVPLAN_VC - Ethernet virtual private local area network connection for DOT1Q ports or virtual devices.
name string
REQUIRED
 Connection name.
Applicable values:
  • Maximum: 24 characters
  • Allowed characters: alpha-numeric, hyphens ('-') and underscores ('_')
Example: my_connection
order object
REQUIRED
 Order details.
purchaseOrderNumber string
OPTIONAL
 Subscriber's purchase order identifier.
Example: 1-129105284100
bandwidth integer
REQUIRED
 Connection bandwidth in Mbps.
Applicable values:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
redundancy object
OPTIONAL
 Connection redundancy configuration.
group string
REQUIRED
 Redundancy group identifier.
Example: 5c0e9384-aa79-4ec9-b7a2-557f8c307292
priority string
REQUIRED
 Relative priority in a redundancy group.
Applicable values:
  • PRIMARY
  • SECONDARY
aSide object
REQUIRED
 Source port definition.
accessPoint object
REQUIRED
 Connection endpoint configuration.
type string
REQUIRED
 Connection endpoint type.
Applicable values:
  • COLO - Colocation space in an IBX data center.
  • VD - Network Edge virtual device.
  • CLOUD_ROUTER - Fabric Cloud Router instance.
  • NETWORK - Fabric network that enables creating multipoint connections.
  • METAL_NETWORK - Metal instance.
port object
REQUIRED
 Port associated with the connection.
uuid string
REQUIRED
 Equinix-assigned port identifier.
linkProtocol object
REQUIRED
 Link protocol configuration.
Applicable to COLO type access points.
type string
REQUIRED
 Link protocol type.
Applicable values:
  • DOT1Q
  • QINQ
  • UNTAGGED
vlanTag integer
REQUIRED
 DOT1Q protocol VLAN tag.
Applicable values:
  • Minimum: 2
  • Maximum: 4094
vlanSTag integer
REQUIRED
 QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Applicable values:
  • Minimum: 2
  • Maximum: 4094
vlanCTag integer
REQUIRED
 QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
Applicable values:
  • Minimum: 2
  • Maximum: 4094
virtualDevice object
REQUIRED
 Virtual device configuration.
Applicable to VD type access points.
type string
REQUIRED
 Equinix-assigned virtual device identifier.
  • EDGE
uuid string
REQUIRED
 Virtual device instance identifier.
interface object
REQUIRED
 Interface configuration.
Applicable to VD type access points.
type string
REQUIRED
 Virtual device network interface type.
Applicable values:
  • NETWORK
  • CLOUD
id integer
REQUIRED
 Virtual device network interface identifier.
Example: 544211
serviceToken object
REQUIRED
 Service token specification.
Applicable to connections that use A-side service tokens.
uuid string
REQUIRED
 Service token identifier.
Example: e05f4f23-d098-4d7c-a9ca-c2897b465107
zSide object
REQUIRED
 Destination port definition.
serviceToken object
REQUIRED
 Service token specification.
Applicable to connections that use Z-side service tokens.
uuid string
REQUIRED
 Service token identifier.
Example: e05f4f23-d098-4d7c-a9ca-c2897b465107
accessPoint object
REQUIRED
 Connection endpoint configuration.
type string
REQUIRED
 Connection endpoint type.
Applicable values:
  • COLO - Colocation space in an IBX data center.
  • SP - Service profile.
  • VD - Network Edge virtual device.
  • NETWORK - Fabric network that enables creating multipoint connections.
  • METAL_NETWORK - Metal instance.
port object
REQUIRED
 Port associated with the connection. Applicable to COLO type access points.
uuid string
REQUIRED
 Equinix-assigned port identifier.
Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
linkProtocol object
REQUIRED
 Link protocol configuration.
Applicable to COLO type access points.
type string
REQUIRED
 Link protocol type.
Applicable values:
  • DOT1Q
  • QINQ
  • UNTAGGED
vlanTag integer
REQUIRED
 DOT1Q protocol VLAN tag.
Applicable values:
  • Minimum: 2
  • Maximum: 4094
vlanTagMin integer
CONDITIONAL
 DOT1Q protocol VLAN tag range lowest value. Applicable to connections originating from Network Edge devices. Required if vlanTag isn't specified.
vlanTagMax integer
CONDITIONAL
 DOT1Q protocol VLAN tag range highest value. Applicable to connections originating from Network Edge devices. Required if vlanTag isn't specified.
vlanSTag integer
REQUIRED
 QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Applicable values:
  • Minimum: 2
  • Maximum: 4094
vlanCTag integer
REQUIRED
 QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
Applicable values:
  • Minimum: 2
  • Maximum: 4094
vlanCTagMin integer
CONDITIONAL
 QINQ protocol lowest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if vlanCTag isn't specified.
vlanCTagMax integer
CONDITOINAL
 QINQ protocol highest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if vlanCTag isn't specified.
profile object
REQUIRED
 A named provider service and its network connectivity requirements.
Applicable to SP type access points.

Use the Retrieve Service Profiles API request to search for service profiles and determine their identifiers and available locations.
type string
REQUIRED
 Service profile type.
Applicable values:
  • L2_PROFILE
uuid string
REQUIRED
 Service profile identifier.
Example: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c
location object
REQUIRED
 Connection endpoint location information.
Applicable to SP type access points.
metroCode string
REQUIRED
 Metropolitan area identifier.
Use the Get Specified Service Profile API request to determine where a given service is available.
network object
REQUIRED
 Fabric network instance information. Applicable to NETWORK type access points.
uuid string
REQUIRED
 Equinix-assigned Fabric network instance identifier.
Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
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
notifications array[object]
REQUIRED
 Notification settings for messages related to the asset configuration or its status.
type string
REQUIRED
 Notification messages category.
Applicable values:
  • ALL
emails array[string]
REQUIRED
 Email addresses of up to 12 recipients.
Example: ["mike@mspp.com","dwight@dm.com"]

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


Sample response - non-redundant connection from a DOT1Q port to a QINQ port

Copy 
{
                        "href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
                        "type": "EVPL_VC",
                        "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
                        "name": "Conn-1",
                        "state": "PENDING_AUTO_APPROVAL",
                        "order": {
                        "purchaseOrderNumber": "1-129105284100",
                        "billingTier": "Up to 1 Gbps"
                        },
                        "bandwidth": 1000,
                        "aSide": {
                        "accessPoint" {
                        "type": "COLO",
                        "port": {
                        "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                        "type": "XF_PORT",
                        "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
                        },
                        "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 1001
                        }
                        }
                        },
                        "zSide": {
                        "accessPoint": {
                        "type": "COLO",
                        "port": {
                        "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                        "type": "XF_PORT",
                        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
                        },
                        "linkProtocol": {
                        "type": "QINQ",
                        "vlanSTag": 2001,
                        "vlanCTag": 2002,
                        }
                        }
                        },
                        "notifications": [
                        {
                        "type": "ALL",
                        "emails": [
                        "test@equinix.com",
                        "test@equinix.com"
                        ]
                        }
                        ],
                        "operation": {
                        "equinixStatus": "PROVISIONING",
                        "providerStatus": "NOT_AVAILABLE"
                        },
                        "changeLog": {
                        "createdDateTime": "2021-07-15T19:30:29.526Z"
                        }
                    }

Response payload body description

Response payload includes configuration parameters defined in the request body. The following table contains descriptions of additional information included in the response payload. For descriptions of the remaining fields, refer to the Body parameters section.

Parameter
Description
href string
 An absolute URL that returns the specified connection.
Example:https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid string
 Equinix-assigned connection identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
state string
 Lifecycle stage of a connection.
Example: PENDING_AUTO_APPROVAL
order object
 Order information.
billingTier string
 Billing tier for connection bandwidth.
Example: Up to 1 Gbps
aSide object
 Source port definition.
accessPoint object
 Connection endpoint configuration.
port object
 Port associated with the connection. Applicable to COLO type access points.
href string
 An absolute URL that returns the specified port.
Example:https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
type string
 Type of port.
Example: XF_PORT - Equinix Fabric port used as a Fabric connection endpoint.
zSide object
 Destination port definition.
accessPoint object
 Connection endpoint configuration.
port object
 Port associated with the connection. Applicable to COLO type access points.
href string
 An absolute URL that returns the specified port.
Example:https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
type string
 Type of port.
Example: XF_PORT - Equinix Fabric port used as a Fabric connection endpoint.
profile object
 A named provider service and its network connectivity requirements.
Applicable to SP type access points.
href string
 An absolute URL that returns complete specification for the given entity.
Example:https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f
type string
 Service profile type.
Example:
  • L2_PROFILE - layer 2 service profile for establishing connections in layer 2 of the OSI networking model.
  • L3_PROFILE - layer 3 service profile for establishing connections in layer 2 of the OSI networking model.
operation object
 Connection type-specific operational data.
equinixStatus string
 Progress towards provisioning a specified connection.
Example: PROVISIONING
providerStatus string
 Provider's progress towards provisioning a specified connection.
Example: NOT_AVAILABLE
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z

Get Specified Connection

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

This API request retrieves details of the specified connection.

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


Sample curl request

Copy 
curl -X
                        GET 'https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
                    -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
uuid string
REQUIRED
 Equinix-assigned connection identifier.

Query parameters

Parameter
Description
direction string
OPTIONAL
 Connection direction from the requestor's perspective.
Applicable values:
  • INCOMING
  • OUTGOING
  • INTERNAL

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


Sample response

Copy 
{
                        "type": "EVPL_VC",
                        "href": "https://api.equinix.com/fabric/v4/connections/d3ba5c1a-7763-492f-8881-091052420bb1",
                        "uuid": "d3ba5c1a-7763-492f-8881-091052420bb1",
                        "name": "SustainStandardConn",
                        "state": "PROVISIONED",
                        "operation": {
                        "providerStatus": "AVAILABLE",
                        "equinixStatus": "PROVISIONED"
                        },
                        "order": {
                        "billingTier": "Up to 1 Gbps",
                        "purchaseOrderNumber": "PO439401015499"
                        },
                        "notifications": [
                        {
                        "type": "ALL",
                        "emails": [
                        "fake@mail.com"
                        ]
                        }
                        ],
                        "account": {
                        "accountNumber": 270106,
                        "orgId": 91996,
                        "globalOrgId": "0016u000003JZ4rAAG"
                        },
                        "changeLog": {
                        "createdBy": "testV",
                        "createdDateTime": "2022-02-09T05:12:32.183Z",
                        "updatedBy": "testBuyerStandardUserAllPerm",
                        "updatedDateTime": "2022-02-09T05:12:33.078Z"
                        },
                        "bandwidth": 1000,
                        "redundancy": {
                        "group": "2e455f6d-da91-4f7d-a50b-40cdcab257fe",
                        "priority": "PRIMARY"
                        },
                        "isRemote": false,
                        "direction": "INCOMING",
                        "aSide": {
                        "accessPoint": {
                        "type": "COLO",
                        "account": {
                        "accountNumber": 270106,
                        "orgId": 91996,
                        "organizationName": "testGlobalcust-270100",
                        "globalOrgId": "0016u000003JZ4rAAG"
                        },
                        "location": {
                        "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",
                        "redundancy": {
                        "priority": "PRIMARY"
                        }
                        },
                        "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 1140
                        }
                        }
                        },
                        "zSide": {
                        "accessPoint": {
                        "type": "SP",
                        "account": {
                        "orgId": 91997,
                        "organizationName": "testBuyer-270001",
                        "globalOrgId": "0016u000003JZ4sAAG"
                        },
                        "location": {
                        "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": 4080
                        }
                        }
                        }
                    }

Response payload body description

Parameter
Description
type string
 Connection type.
Example:
  • EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections.
  • EPL_VC - Ethernet private line connection type used for untagged layer 2 connections.
  • ACCESS_EPL_VC - E-access, layer 2 connection between a QINQ port and an EPL port.
  • IP_VC - Layer 2 connection between a Fabric Cloud Router instance and a port.
  • EVPLAN_VC - Ethernet virtual private local area network connection for DOT1Q ports or virtual devices.
href string
 An absolute URL that returns the specified connection.
Example:https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid string
 Equinix-assigned connection identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
name string
 Connection name.
Example: my_connection
state string
 Lifecycle stage of a connection.
Example: PENDING_AUTO_APPROVAL
operation object
 Connection type-specific operational data.
equinixStatus string
 Progress towards provisioning a specified connection.
Example: PROVISIONING
providerStatus string
 Provider's progress towards provisioning a specified connection.
Example: NOT_AVAILABLE
order object
 Order details.
purchaseOrderNumber string
 Subscriber's purchase order identifier.
Example: 1-129105284100
billingTier string
 Billing tier for connection bandwidth.
Example: Up to 1 Gbps
notifications array[object]
 Notification settings for messages related to the asset configuration or its status.
type string
 Notification messages category.
Example:
  • ALL
emails array[string]
 Email addresses of up to 12 recipients.
Example: ["mike@mspp.com","dwight@dm.com"]
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId integer
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
bandwidth integer
 Connection bandwidth in Mbps.
Example:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
redundancy object
 Connection redundancy configuration.
group string
 Redundancy group identifier.
Example: 5c0e9384-aa79-4ec9-b7a2-557f8c307292
priority string
 Relative priority in a redundancy group.
Example:
  • PRIMARY
  • SECONDARY
isRemote boolean
 Indicates if both connection endpoints are in the same location.
Example: false
direction string
 Direction of the connection (from the requester's point of view).
Example: OUTGOING
aSide object
 Source port definition.
accessPoint object
 Connection endpoint configuration.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
  • VD - Network Edge virtual device.
  • CLOUD_ROUTER - Fabric Cloud Router instance.
  • NETWORK - Fabric network that enables creating multipoint connections.
  • METAL_NETWORK - Metal instance.
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId integer
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
location object
 Port associated with the connection.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
port object
 Port associated with the connection.
href string
 An absolute URL that returns the specified port.
Example:https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid string
 Equinix-assigned port identifier.
Example:
name string
 Equinix-assigned port name.
Example: 272010-SV5-CX-Secondary-01
redundancy object
 Port redundancy information.
priority string
 Relative port priority.
Example: SECONDARY
linkProtocol object
 Link protocol configuration.
Applicable to COLO and VD type access points.
type string
 Link protocol type.
Example:
  • DOT1Q
  • QINQ
  • UNTAGGED
vlanTag integer
 DOT1Q protocol VLAN tag.
Example: 222
vlanSTag integer
 QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTag integer
 QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
Example: 333
virtualDevice object
 Virtual device configuration.
Applicable to VD type access points.
type string
 Equinix-assigned virtual device identifier.
  • EDGE
uuid string
 Virtual device instance identifier.
interface object
 Interface configuration.
Applicable to VD type access points.
type string
 Virtual device network interface type.
Example:
  • NETWORK
  • CLOUD
id integer
 Virtual device network interface identifier.
Example: 544211
router object
 Cloud Router associated with the connection.
href string
 Absolute URL that returns the specified entity.
Example:http://api.equinix.com/fabric/v4/routers/bb818900-d4b4-445a-85a2-cecd88061662
uuid string
 Fabric Cloud Router identifier.
Example: bb818900-d4b4-445a-85a2-cecd88061662
name string
 Fabric Cloud Router name.
Example: E2E-API-FG
serviceToken object
 Service token specification.
Applicable to connections that use A-side service tokens.
uuid string
 Service token identifier.
Example: e05f4f23-d098-4d7c-a9ca-c2897b465107
zSide object
 Destination port definition.
accessPoint object
 Connection endpoint configuration.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
  • SP - Service profile.
  • VD - Network Edge virtual device.
  • NETWORK - Fabric network that enables creating multipoint connections.
  • METAL_NETWORK - Metal instance.
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId string
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
location object
 Port associated with the connection.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
port object
 Port associated with the connection.
href string
 An absolute URL that returns the specified port.
Example:https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid string
 Equinix-assigned port identifier.
Example:
name string
 Equinix-assigned port name.
Example: 272010-SV5-CX-Secondary-01
redundancy object
 Port redundancy information.
priority string
 Relative port priority.
Example: SECONDARY
linkProtocol object
 Link protocol configuration.
Applicable to COLO and VD type access points.
type string
 Link protocol type.
Example:
  • DOT1Q
  • QINQ
  • UNTAGGED
vlanTag integer
 DOT1Q protocol VLAN tag.
Example: 222
vlanTagMin integer
 DOT1Q protocol VLAN tag range lowest value. Applicable to connections originating from Network Edge devices. Required if vlanTag isn't specified.
Example: 222
vlanTagMax integer
 DOT1Q protocol VLAN tag range highest value. Applicable to connections originating from Network Edge devices. Required if vlanTag isn't specified.
Example: 333
vlanSTag integer
 QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTag integer
 QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTagMin integer
 QINQ protocol lowest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if vlanCTag isn't specified.
Example: 222
vlanCTagMax integer
 QINQ protocol highest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if vlanCTag isn't specified.
Example: 333
profile object
 A named provider service and its network connectivity requirements.
Applicable to SP type access points.

Use the Retrieve Service Profiles API request to search for service profiles and determine their identifiers and available locations.
type string
 Service profile type.
Example: L2_PROFILE
uuid string
 Service profile identifier.
Example: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c
location object
 Connection endpoint location information.
Applicable to SP type access points.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
network object
 Fabric network instance information. Applicable to NETWORK type access points.
uuid string
 Equinix-assigned Fabric network instance identifier.
Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
name string
 Network name.
Example: EPLAN-GLOBAL-1017a
type string
 Network type.
Example: EPLAN
scope string
 Network geographic scope.
Example: GLOBAL
serviceToken object
 Service token specification.
Applicable to connections that use Z-side service tokens.
uuid string
 Service token identifier.
Example: e05f4f23-d098-4d7c-a9ca-c2897b465107

Retrieve Connections

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

This API request retrieves layer 2 connections that match provided search criteria.

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/connections/search'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '{
                        "filter": {
                        "and": [
                        {
                        "property": "/direction",
                        "operator": "=",
                        "values": [
                        "OUTGOING"
                        ]
                        },
                        {
                        "property": "/operation/equinixStatus",
                        "operator": "=",
                        "values": [
                        "PROVISIONING"
                        ]
                        }
                        ]
                        },
                        "pagination": {
                        "limit": 25,
                        "offset": 0,
                        "total": 0
                        },
                        "sort": [
                        {
                        "property": "/name",
                        "direction": "DESC"
                        }
                        ]
                    }'

Body parameters

Parameter
Description
filter object
REQUIRED
 Object defining search conditions.
and array[object]
REQUIRED
 Array of search parameters.
property string
REQUIRED
 Search parameter.
Applicable values:
  • /isRemote
  • /name
  • /uuid
  • /account/orgId
  • /aSide/accessPoint/account/accountName
  • /aSide/accessPoint/account/accountNumber
  • /aSide/accessPoint/router/uuid
  • /aSide/accessPoint/linkProtocol/vlanCTag
  • /aSide/accessPoint/linkProtocol/vlanSTag
  • /aSide/accessPoint/location/metroCode
  • /aSide/accessPoint/location/metroName
  • /aSide/accessPoint/name
  • /aSide/accessPoint/port/uuid
  • /aSide/accessPoint/port/name
  • /aSide/accessPoint/type
  • /aSide/accessPoint/virtualDevice/name
  • /aSide/accessPoint/virtualDevice/uuid
  • /aSide/serviceToken/uuid
  • /change/status
  • /operation/equinixStatus
  • /operation/providerStatus
  • /project/projectId
  • /redundancy/group
  • /redundancy/priority
  • /zSide/accessPoint/account/accountName
  • /zSide/accessPoint/authenticationKey
  • /zSide/accessPoint/linkProtocol/vlanCTag
  • /zSide/accessPoint/linkProtocol/vlanSTag
  • /zSide/accessPoint/location/metroCode
  • /zSide/accessPoint/location/metroName
  • /zSide/accessPoint/name
  • /zSide/accessPoint/port/uuid
  • /zSide/accessPoint/network/uuid
  • /zSide/accessPoint/port/name
  • /zSide/accessPoint/profile/uuid
  • /zSide/accessPoint/type
  • /zSide/accessPoint/virtualDevice/name
  • /zSide/accessPoint/virtualDevice/uuid
  • /zSide/serviceToken/uuid
  • *
operator string
REQUIRED
 Search parameter operator.
Applicable values:
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • BETWEEN
  • NOT BETWEEN
  • LIKE
  • NOT LIKE
  • IN
  • NOT IN
  • ~* - Case insensitive like.
values string
REQUIRED
 Search parameter value.
Example: ACTIVE
pagination object
OPTIONAL
 Search results pagination settings.
offset integer
OPTIONAL
 Index of the first item returned in the response.
Minimum: 0
Default value: 0
limit integer
OPTIONAL
 Maximum number of items returned per page.
Minimum: 1
Maximum: 100
Default value: 20
sort object
OPTIONAL
 Search results sorting settings.
direction string
OPTIONAL
 Search results sorting direction.
Applicable values:
  • ASC
  • DESC
property string
OPTIONAL
 Search results sorting parameter.
Applicable values:
  • /name
  • /direction
  • /aSide/accessPoint/name
  • /aSide/accessPoint/type
  • /aSide/accessPoint/account/accountName
  • /aSide/accessPoint/location/metroName
  • /aSide/accessPoint/location/metroCode
  • /aSide/accessPoint/linkProtocol/vlanCTag
  • /aSide/accessPoint/linkProtocol/vlanSTag
  • /zSide/accessPoint/name
  • /zSide/accessPoint/type
  • /zSide/accessPoint/account/accountName
  • /zSide/accessPoint/location/metroName
  • /zSide/accessPoint/location/metroCode
  • /zSide/accessPoint/linkProtocol/vlanCTag
  • /zSide/accessPoint/linkProtocol/vlanSTag
  • /zSide/accessPoint/authenticationKey
  • /bandwidth
  • /uuid
  • /changeLog/createdDateTime
  • /changeLog/updatedDateTime
  • /operation/equinixStatus
  • /operation/providerStatus
  • /redundancy/priority

Default value: /changeLog/updatedDateTime
/name Example:
"property": "/name",
"operator": "LIKE",
"values": [
"%myFavoriteConnection%"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • !=
  • LIKE
  • IN
  • NOT LIKE
  • NOT IN
  • ~*
value array[string]
REQUIRED
 Connection name.
Example: ["%myFavoriteConnection%"]
/uuid Example:
"property": "/uuid",
"operator": "=",
"values": [
"3a58dd05-f46d-4b1d-a154-2e85c396ea62
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
value array[string]
REQUIRED
 Connection identifier.
Example: ["3a58dd05-f46d-4b1d-a154-2e85c396ea62"]
/account/orgId Example:
"property": "/account/orgId",
"operator": "=",
"values": [
91997
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[integer]
REQUIRED
 Equinix-assigned organization identifier.
Example: [91997]
/aSide/accessPoint/account/accountName
/zSide/accessPoint/account/accountName 		Example:
"property": "/aSide/accessPoint/account/accountName",
"operator": "=",
"values": [
"John Doe"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Legal name of the account holder.
Example: ["John Doe"]
/aSide/accessPoint/account/accountNumber Example:
"property": "/aSide/accessPoint/account/accountNumber",
"operator": "=",
"values": [
299001
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
value array[integer]
REQUIRED
 Customer account number.
Example: [299001]
/aSide/accessPoint/router/uuid Example:
"property": "/aSide/accessPoint/router/uuid",
"operator": "=",
"values": [
"cea65afb-aa36-a366-2ae0-387a5c00a944"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
value array[string]
REQUIRED
 Equinix-assigned Fabric Cloud Router identifier.
Example: cea65afb-aa36-a366-2ae0-387a5c00a944
/aSide/accessPoint/linkProtocol/vlanCTag
/zSide/accessPoint/linkProtocol/vlanCTag 		Example:
"property": "/aSide/accessPoint/linkProtocol/vlanCTag",
"operator": "=",
"values": [
"486"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
value array[integer]
REQUIRED
 QINQ protocol inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
Example: ["486"]
/aSide/accessPoint/linkProtocol/vlanSTag
/zSide/accessPoint/linkProtocol/vlanSTag 		Example:
"property": "/aSide/accessPoint/linkProtocol/vlanSTag",
"operator": "=",
"values": [
"486"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
value array[integer]
REQUIRED
 QINQ protocol outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Example: ["486"]
/aSide/accessPoint/location/metroCode
/zSide/accessPoint/location/metroCode 		Example:
"property": "/aSide/accessPoint/location/metroCode",
"operator": "=",
"values": [
"SV"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Metropolitan area identifier.
Use the Get All Metros API request to retrieve the list of available metros.
Example: ["SV"]
/aSide/accessPoint/location/metroName
/zSide/accessPoint/location/metroName 		Example:
"property": "/aSide/accessPoint/location/metroName",
"operator": "=",
"values": [
"Silicon Valley"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Metropolitan area name.
Example: ["Silicon Valley"]
/aSide/accessPoint/name
/zSide/accessPoint/name 		Example:
"property": "/aSide/accessPoint/name",
"operator": "=",
"values": [
"Name"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
value array[string]
REQUIRED
 Access point name.
Example: ["Name"]
/aSide/accessPoint/port/uuid
/zSide/accessPoint/port/uuid 		Example:
"property": "/aSide/accessPoint/port/uuid",
"operator": "=",
"values": [
"cea65afb-aa34-a346-2ae0-387a5c00a944"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
value array[string]
REQUIRED
 Equinix-assigned port identifier. Use the Get All Ports API request to retrieve ports information.
Example: ["cea65afb-aa34-a346-2ae0-387a5c00a944"]
/aSide/accessPoint/port/name
/zSide/accessPoint/port/name 		Example:
"property": "/aSide/accessPoint/port/name",
"operator": "=",
"values": [
"290071-WA1-NL-Qinq-10G-9"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Equinix-assigned port identifier. Use the Get All Ports API request to retrieve ports information.
Example: ["290071-WA1-NL-Qinq-10G-9"]
/aSide/accessPoint/type
/zSide/accessPoint/type 		Example:
"property": "/aSide/accessPoint/type",
"operator": "=",
"values": [
"COLO"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Metropolitan area name.
Applicable values:
  • COLO - Colocation endpoint in an Equinix IBX data center.
  • SP - Service profile.
  • VD - Netork Edge virtual device.
  • CLOUD_ROUTER - Fabric Cloud Router instance.
  • NETWORK - Fabric network that enables creating multipoint connections.
  • METAL_NETWORK - Metal instance.
/aSide/accessPoint/virtualDevice/name
/zSide/accessPoint/virtualDevice/name 		Example:
"property": "/zSide/accessPoint/virtualDevice/name",
"operator": "=",
"values": [
"E2E-NE-Device-Aut-171221033749146"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Virtual device name.
Example: ["E2E-NE-Device-Aut-171221033749146"]
/aSide/accessPoint/virtualDevice/uuid
/zSide/accessPoint/virtualDevice/uuid 		Example:
"property": "/zSide/accessPoint/virtualDevice/uuid",
"operator": "=",
"values": [
"0e9daf19-72bd-4ba7-b305-e0132740224b"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Equinix-assigned virtual device identifier.
Example: ["0e9daf19-72bd-4ba7-b305-e0132740224b"]
/aSide/serviceToken/uuid
/zSide/serviceToken/uuid 		Example:
"property": "/zSide/serviceToken/uuid",
"operator": "=",
"values": [
"0e9daf19-72bd-4ba7-b305-e0132740224b"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Equinix-assigned service token identifier.
Example: ["0e9daf19-72bd-4ba7-b305-e0132740224b"]
/project/projectId Example:
"property": "/project/projectId",
"operator": "=",
"values": [
"1003513458238"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Customer project identifier.
Example: ["1003513458238"]
/zSide/accessPoint/authenticationKey Example:
"property": "/zSide/accessPoint/authenticationKey",
"operator": "=",
"values": [
"qwerASDF"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Z-side acess point authentication key.
Example: ["qwerASDF"]
/zSide/accessPoint/profile/uuid Example:
"property": "/zSide/accessPoint/profile/uuid",
"operator": "=",
"values": [
"0e9daf19-72bd-4ba7-b305-e0132740224b"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Equinix-assigned service profile identifier.
Example: ["0e9daf19-72bd-4ba7-b305-e0132740224b"]
/zSide/accessPoint/network/uuid Example:
"property": "/zSide/accessPoint/network/uuid",
"operator": "=",
"values": [
"0e9daf19-72bd-4ba7-b305-e0132740224b"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Fabric network instance identifier.
Example: ["0e9daf19-72bd-4ba7-b305-e0132740224b"]
/change/status Example:
"property": "/change/status",
"operator": "=",
"values": [
"SUBMITTED_FOR_APPROVAL"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Operation status life cycle.
Applicable values:
  • SUBMITTED_FOR_APPROVAL
  • APPROVED
  • REJECTED
/operation/equinixStatus Example:
"property": "/operation/equinixStatus",
"operator": "=",
"values": [
"PROVISIONED"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Progress toward provisioning a specified connection.
Applicable values:
  • REJECTED_ACK
  • REJECTED
  • PENDING_DELETE
  • PROVISIONED
  • BEING_REPROVISIONED
  • BEING_DEPROVISIONED
  • BEING_PROVISIONED
  • CREATED
  • ERRORED
  • PENDING_DEPROVISIONING
  • APPROVED
  • ORDERING
  • PENDING_APPROVAL
  • NOT_PROVISIONED
  • DEPROVISIONING
  • NOT_DEPROVISIONED
  • PENDING_AUTO_APPROVAL
  • PROVISIONING
  • PENDING_BGP_PEERING
  • PENDING_PROVIDER_VLAN
  • DEPROVISIONED
  • DELETED
  • PENDING_BANDWIDTH_APPROVAL
  • AUTO_APPROVAL_FAILED
  • UPDATE_PENDING
  • DELETED_API
  • MODIFIED
  • PENDING_PROVIDER_VLAN_ERROR
  • DRAFT
  • CANCELLED
  • PENDING_INTERFACE_CONFIGURATION
/operation/providerStatus Example:
"property": "/operation/providerStatus",
"operator": "=",
"values": [
"AVAILABLE"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Provider's progress toward provisioning a specified connection.
Applicable values:
  • AVAILABLE
  • DEPROVISIONED
  • DEPROVISIONING
  • FAILED
  • NOT_AVAILABLE
  • PENDING_APPROVAL
  • PROVISIONED
  • PROVISIONING
  • REJECTED
  • PENDING_BGP
  • OUT_OF_BANDWIDTH
  • DELETED
  • ERROR
  • ERRORED
  • NOTPROVISIONED
  • ORDERING
  • DELETING
  • PENDING DELETE
/redundancy/group Example:
"property": "/redundancy/group",
"operator": "=",
"values": [
"0e9daf19-72bd-4ba7-b305-e0132740224b"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Redundancy group identifier.
Example: ["0e9daf19-72bd-4ba7-b305-e0132740224b"]
/redundancy/priority Example:
"property": "/redundancy/priority",
"operator": "=",
"values": [
"PRIMARY"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • LIKE
value array[string]
REQUIRED
 Relative priority within the redundancy group.
Applicable values:
  • PRIMARY
  • SECONDARY
/isRemote Example:
"property": "/isRemote",
"operator": "=",
"values": [
false
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
value array[string]
REQUIRED
 Indicates if both connection endpoints are in the same location.
Applicable values:
  • true
  • false
/* Example:
"property": "/*",
"operator": "LIKE",
"values": [
"%Silicon%"
]
operator string
REQUIRED
 Search field parameter operator.
Use the Get All Ports API request to retrieve ports information.
Example:
  • =
  • !=
  • LIKE
  • IN
  • NOT LIKE
  • NOT IN
  • ~*
value array[string]
REQUIRED
 All categories search.
Example: ["%Silicon%"]

Sample response

Copy 
{
                        "data": [
                        {
                        "type": "EVPL_VC",
                        "href": "https://api.equinix.com/fabric/v4/connections/50a4ad8f-2b00-434a-9ea1-f3bbb894541f",
                        "uuid": "50a4ad8f-2b00-434a-9ea1-f3bbb894541f",
                        "name": "P2SPConn012",
                        "state": "PROVISIONED",
                        "change": {
                        "uuid": "da6a1a0b-0872-4c06-b9d7-5c8ee3056775",
                        "type": "CONNECTION_UPDATE",
                        "status": "APPROVED",
                        "createdDateTime": "2021-12-12T06:00:01.183Z",
                        "updatedDateTime": "2021-12-12T06:00:09.278916Z",
                        "data": {
                        "op": "replace",
                        "path": "/aSide/accessPoint/port/uuid",
                        "value": "c791f8cb-58f9-8f90-8ce0-306a5c00a4ee"
                        }
                        },
                        "operation": {
                        "providerStatus": "AVAILABLE",
                        "equinixStatus": "PROVISIONED"
                        },
                        "order": {
                        "purchaseOrderNumber": "POTEST1"
                        },
                        "notifications": [
                        {
                        "type": "ALL",
                        "emails": [
                        "dragonstestBuyer@equinix.com"
                        ]
                        }
                        ],
                        "account": {
                        "accountNumber": 270001,
                        "orgId": 91997,
                        "globalOrgId": "0016u000003JZ4sAAG"
                        },
                        "changeLog": {
                        "createdBy": "dragonstestBuyer",
                        "createdDateTime": "2021-11-19T22:56:24.666Z",
                        "updatedBy": "dragonstestBuyer"
                        },
                        "bandwidth": 10000,
                        "redundancy": {
                        "group": "66c10a60-789e-4b25-b85c-7eb225a4c344",
                        "priority": "PRIMARY"
                        },
                        "isRemote": true,
                        "direction": "OUTGOING",
                        "aSide": {
                        "accessPoint": {
                        "type": "COLO",
                        "account": {
                        "accountNumber": 270001,
                        "orgId": 91997,
                        "organizationName": "testBuyer-270001",
                        "globalOrgId": "0016u000003JZ4sAAG"
                        },
                        "location": {
                        "href": "https://api.equinix.com/fabric/v4/metros/MetroCode(value=SV)",
                        "region": "AMER",
                        "metroName": "Silicon Valley",
                        "metroCode": "SV"
                        },
                        "port": {
                        "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-58fa-8fa0-8ce0-306a5c00a4ee",
                        "uuid": "c791f8cb-58fa-8fa0-8ce0-306a5c00a4ee",
                        "name": "testBuyer-SV1-L-Dot1q-STD-PRI-10G-JN-2",
                        "redundancy": {
                        "priority": "PRIMARY"
                        }
                        },
                        "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 2021
                        }
                        }
                        },
                        "zSide": {
                        "accessPoint": {
                        "type": "SP",
                        "account": {
                        "orgId": 92154,
                        "organizationName": "testSeller1-270271",
                        "globalOrgId": "0016u000003JZ59AAG"
                        },
                        "location": {
                        "href": "https://api.equinix.com/fabric/v4/metros/MetroCode(value=DA)",
                        "region": "AMER",
                        "metroName": "Dallas",
                        "metroCode": "DA"
                        },
                        "port": {
                        "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-5a85-a850-8ce0-306a5c00a4ee",
                        "uuid": "c791f8cb-5a85-a850-8ce0-306a5c00a4ee",
                        "name": "testSeller1-DA1-L-Dot1q-STD-SEC-10G-NK-397",
                        "redundancy": {
                        "priority": "SECONDARY"
                        }
                        },
                        "profile": {
                        "type": "L2_PROFILE",
                        "name": "Non-Redundant-DOT1Q-SP",
                        "uuid": "bebd6257-bf4d-4819-8ff9-e921c564ce26"
                        },
                        "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 458
                        }
                        }
                        }
                        }
                        ],
                        "pagination": {
                        "offset": 0,
                        "limit": 25,
                        "total": 1
                        }
                    }

Response payload body description

Parameter
Description
data array[object]
 Data array containing search results.
type string
 Connection type.
Example:
  • EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections.
  • EPL_VC - Ethernet private line connection type used for untagged layer 2 connections.
  • ACCESS_EPL_VC - E-access, layer 2 connection between a QINQ port and an EPL port.
  • IP_VC - Layer 2 connection between a Fabric Cloud Router instance and a port.
  • EVPLAN_VC - Ethernet virtual private local area network connection for DOT1Q ports or virtual devices.
href string
 An absolute URL that returns the specified connection.
Example:https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid string
 Equinix-assigned connection identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
name string
 Connection name.
Example: my_connection
state string
 Lifecycle stage of a connection.
Example: PENDING_AUTO_APPROVAL
operation object
 Connection type-specific operational data.
equinixStatus string
 Progress towards provisioning a specified connection.
Example: PROVISIONING
providerStatus string
 Provider's progress towards provisioning a specified connection.
Example: NOT_AVAILABLE
order object
 Order details.
purchaseOrderNumber string
 Subscriber's purchase order identifier.
Example: 1-129105284100
billingTier string
 Billing tier for connection bandwidth.
Example: Up to 1 Gbps
notifications array[object]
 Notification settings for messages related to the asset configuration or its status.
type string
 Notification messages category.
Example:
  • ALL
emails array[string]
 Email addresses of up to 12 recipients.
Example: ["mike@mspp.com","dwight@dm.com"]
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId integer
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
bandwidth integer
 Connection bandwidth in Mbps.
Example:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
redundancy object
 Connection redundancy configuration.
group string
 Redundancy group identifier.
Example: 5c0e9384-aa79-4ec9-b7a2-557f8c307292
priority string
 Relative priority in a redundancy group.
Example:
  • PRIMARY
  • SECONDARY
isRemote boolean
 Indicates if both connection endpoints are in the same location.
Example: false
direction string
 Direction of the connection (from the requester's point of view).
Example: OUTGOING
aSide object
 Source port definition.
accessPoint object
 Connection endpoint configuration.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
  • VD - Network Edge virtual device.
  • CLOUD_ROUTER - Fabric Cloud Router instance.
  • NETWORK - Fabric network that enables creating multipoint connections.
  • METAL_NETWORK - Metal instance.
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId integer
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
location object
 Port associated with the connection.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
port object
 Port associated with the connection.
href string
 An absolute URL that returns the specified port.
Example:https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid string
 Equinix-assigned port identifier.
Example:
name string
 Equinix-assigned port name.
Example: 272010-SV5-CX-Secondary-01
redundancy object
 Port redundancy information.
priority string
 Relative port priority.
Example: SECONDARY
linkProtocol object
 Link protocol configuration.
Applicable to COLO and VD type access points.
type string
 Link protocol type.
Example:
  • DOT1Q
  • QINQ
  • UNTAGGED
vlanTag integer
 DOT1Q protocol VLAN tag.
Example: 222
vlanSTag integer
 QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTag integer
 QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
Example: 333
virtualDevice object
 Virtual device configuration.
Applicable to VD type access points.
type string
 Equinix-assigned virtual device identifier.
  • EDGE
uuid string
 Virtual device instance identifier.
interface object
 Interface configuration.
Applicable to VD type access points.
type string
 Virtual device network interface type.
Example:
  • NETWORK
  • CLOUD
id integer
 Virtual device network interface identifier.
Example: 544211
router object
 Cloud Router associated with the connection.
href string
 Absolute URL that returns the specified entity.
Example:http://api.equinix.com/fabric/v4/routers/bb818900-d4b4-445a-85a2-cecd88061662
uuid string
 Fabric Cloud Router identifier.
Example: bb818900-d4b4-445a-85a2-cecd88061662
name string
 Fabric Cloud Router name.
Example: E2E-API-FG
serviceToken object
 Service token specification.
Applicable to connections that use A-side service tokens.
uuid string
 Service token identifier.
Example: e05f4f23-d098-4d7c-a9ca-c2897b465107
zSide object
 Destination port definition.
accessPoint object
 Connection endpoint configuration.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
  • SP - Service profile.
  • VD - Network Edge virtual device.
  • NETWORK - Fabric network that enables creating multipoint connections.
  • METAL_NETWORK - Metal instance.
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId string
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
location object
 Port associated with the connection.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
port object
 Port associated with the connection.
href string
 An absolute URL that returns the specified port.
Example:https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid string
 Equinix-assigned port identifier.
Example:
name string
 Equinix-assigned port name.
Example: 272010-SV5-CX-Secondary-01
redundancy object
 Port redundancy information.
priority string
 Relative port priority.
Example: SECONDARY
linkProtocol object
 Link protocol configuration.
Applicable to COLO and VD type access points.
type string
 Link protocol type.
Example:
  • DOT1Q
  • QINQ
  • UNTAGGED
vlanTag integer
 DOT1Q protocol VLAN tag.
Example: 222
vlanTagMin integer
 DOT1Q protocol VLAN tag range lowest value. Applicable to connections originating from Network Edge devices. Required if vlanTag isn't specified.
Example: 222
vlanTagMax integer
 DOT1Q protocol VLAN tag range highest value. Applicable to connections originating from Network Edge devices. Required if vlanTag isn't specified.
Example: 333
vlanSTag integer
 QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTag integer
 QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTagMin integer
 QINQ protocol lowest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if vlanCTag isn't specified.
Example: 222
vlanCTagMax integer
 QINQ protocol highest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if vlanCTag isn't specified.
Example: 333
profile object
 A named provider service and its network connectivity requirements.
Applicable to SP type access points.

Use the Retrieve Service Profiles API request to search for service profiles and determine their identifiers and available locations.
type string
 Service profile type.
Example: L2_PROFILE
uuid string
 Service profile identifier.
Example: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c
location object
 Connection endpoint location information.
Applicable to SP type access points.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
network object
 Fabric network instance information. Applicable to NETWORK type access points.
uuid string
 Equinix-assigned Fabric network instance identifier.
Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
name string
 Network name.
Example: EPLAN-GLOBAL-1017a
type string
 Network type.
Example: EPLAN
scope string
 Network geographic scope.
Example: GLOBAL
serviceToken object
 Service token specification.
Applicable to connections that use Z-side service tokens.
uuid string
 Service token identifier.
Example: e05f4f23-d098-4d7c-a9ca-c2897b465107

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


Update Connection

PATCH /fabric/v4/connections/{uuid}
Method PATCH
URL or Endpoint /fabric/v4/connections/{uuid}
Headers Authorization, Content-Type
Path Parameters uuid
Query Parameters Not applicable
Body Parameters op, path, value

This API enables modifying connection parameters.

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


Sample curl request - update connection name

Copy 
curl -X
                        PATCH 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '[
                        {
                        "op": "replace",
                        "path": "/name",
                        "value": "Conn-Name-2"
                        }
                    ]'

Sample curl request - update connection bandwidth

Copy 
curl -X
                        PATCH 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '[
                        {
                        "op": "replace",
                        "path": "/bandwidth",
                        "value": 1000
                        }
                    ]'

Sample curl request - update A-side port

Copy 
curl -X
                        PATCH 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '[
                        {
                        "op": "replace",
                        "path": "/aSide/accessPoint/port/uuid",
                        "value": "c791f8cb-599a-99a0-8ce0-306a5c00a4ee"
                        }
                    ]'

Sample curl request - update notifications recipients

Copy 
curl -X
                        PATCH 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '[
                        {
                        "op": "replace",
                        "path": "/notifications",
                        "value": [
                        {
                        "type": "ALL",
                        "emails": [
                        "testEmail1@equinix.com",
                        "testEmail2@equinix.com"
                        ]
                        }
                        ]
                        }
                    ]'

Sample curl request - update A-side Virtual Device

Copy 
curl -X
                        PATCH 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '[
                        {
                        "op": "replace",
                        "path": "/aSide/accessPoint",
                        "value": {
                        "virtualDevice": {
                        "type": "EDGE",
                        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
                        },
                        "interface": {
                        "type": "NETWORK",
                        "id": 5
                        }
                        }
                        }
                    ]'

Path parameters

Parameter
Description
uuid string
REQUIRED
 Equinix-assigned connection identifier.

Body parameters

Parameter
Description
op string
REQUIRED
 Update reqest type.
Applicable values:
  • replace
path string
REQUIRED
 Parameter path.
Applicable values:
  • /name
  • /bandwidth
  • /aSide/accessPoint/port/uuid
  • /notifications
value string
REQUIRED
 New parameter value.
/name
value string
REQUIRED
 Connection name.
Applicable values:
  • Maximum: 24 characters
  • Allowed characters: alpha-numeric, hyphens ('-') and underscores ('_')
Example: Conn-Name-2
/bandwidth
value integer
REQUIRED
 Connection bandwidth in Mbps.
Applicable values:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
/aSide/accessPoint/port/uuid
value string
REQUIRED
 Equinix-assigned port identifier.
Use the Get All Ports API request to retrieve available ports information.
Example: c791f8cb-599a-99a0-8ce0-306a5c00a4ee
/notifications
value array[object]
REQUIRED
 List of up to 12 recipients.
Example:
[
{
"type": "ALL",
"emails": [
"email1@eqix.com",
"email2@eqix.com"
]
}
]
/aSide/accessPoint
value object[object]
REQUIRED
 Id of the Virtual Device and the interface Id.
Example:
{
"virtualDevice": {
"type": "EDGE",
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
},
"interface": {
"type": "NETWORK",
"id": 5
}
}

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


Sample response - update connection bandwidth

Copy 
{
                        "href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
                        "type": "EVPL_VC",
                        "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
                        "name": "Conn-Name-2",
                        "state": "PROVISIONED",
                        "change": {
                        "uuid": "af90d2b5-c7f9-4183-b050-637b7a9e3bf7",
                        "type": "CONNECTION_UPDATE",
                        "status": "COMPLETED",
                        "createdDateTime": "2022-11-30T08:37:14.536Z",
                        "updatedDateTime": "2022-11-30T08:41:21.539960Z",
                        "data": {
                        "op": "replace",
                        "path": "/bandwidth",
                        "value": "1000"
                        }
                        },
                        "order": {
                        "purchaseOrderNumber": "1-129105284100",
                        "billingTier": "Up to 1 Gbps"
                        },
                        "bandwidth": 1000,
                        "redundancy": {
                        "group": "m167f685-41b0-1b07-6de0-320a5c00abeu",
                        "priority": "PRIMARY"
                        },
                        "aSide": {
                        "accessPoint": {
                        "type": "COLO",
                        "port": {
                        "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                        "type": "XF_PORT",
                        "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
                        },
                        "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 1001
                        }
                        }
                        },
                        "zSide": {
                        "accessPoint": {
                        "type": "SP",
                        "profile": {
                        "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                        "type": "L2_Profile",
                        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
                        },
                        "location": {
                        "href": "https://api.equinix.com/v4/metros/SV",
                        "metrocode": "SV",
                        "region": "AMER"
                        }
                        }
                        },
                        "notifications": [
                        {
                        "type": "ALL",
                        "emails": [
                        "test@equinix.com",
                        "test@equinix.com"
                        ]
                        }
                        ],
                        "operation": {
                        "equinixStatus": "PROVISIONED",
                        "providerStatus": "PROVISIONED"
                        },
                        "changeLog": {
                        "createdDateTime": "2021-07-15T19:30:29.526Z",
                        "updatedDateTime": "2021-08-15T19:30:29.526Z"
                        }
                    }

Response payload body description

Parameter
Description
type string
 Connection type.
Example:
  • EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections.
  • EPL_VC - Ethernet private line connection type used for untagged layer 2 connections.
  • ACCESS_EPL_VC - E-access, layer 2 connection between a QINQ port and an EPL port.
  • IP_VC - Layer 2 connection between a Fabric Cloud Router instance and a port.
  • EVPLAN_VC - Ethernet virtual private local area network connection for DOT1Q ports or virtual devices.
href string
 An absolute URL that returns the specified connection.
Example:https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid string
 Equinix-assigned connection identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
name string
 Connection name.
Example: my_connection
state string
 Lifecycle stage of a connection.
Example: PENDING_AUTO_APPROVAL
change object
 Specifics of the connections change.
uuid string
 Equinix-assigned change request identifier.
Example: af90d2b5-c7f9-4183-b050-637b7a9e3bf7
type string
 Change request type.
Example: CONNECTION_UPDATE
status string
 Change request processing status.
Example: COMPLETED
createdDateTime string
 Change request creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
updatedDateTime string
 Change request update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
data object
 Change request details.
op string
 Update reqest type.
Example: replace
path string
 Parameter path.
Example: /bandwidth
value string/integer
 New parameter value.
Example: 1000
operation object
 Connection type-specific operational data.
equinixStatus string
 Progress towards provisioning a specified connection.
Example: PROVISIONING
providerStatus string
 Provider's progress towards provisioning a specified connection.
Example: NOT_AVAILABLE
op string
 Update reqest type.
Example: replace
path string
 Parameter path.
Example: /aSide/accessPoint/port/uuid
value string
 Parameter value.
Example: c791f8cb-58f9-8f90-8ce0-306a5c00a4ee
order object
 Order details.
purchaseOrderNumber string
 Subscriber's purchase order identifier.
Example: 1-129105284100
billingTier string
 Billing tier for connection bandwidth.
Example: Up to 1 Gbps
notifications array[object]
 Notification settings for messages related to the asset configuration or its status.
type string
 Notification messages category.
Example:
  • ALL
emails array[string]
 Email addresses of up to 12 recipients.
Example: ["mike@mspp.com","dwight@dm.com"]
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId integer
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
bandwidth integer
 Connection bandwidth in Mbps.
Example:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
redundancy object
 Connection redundancy configuration.
group string
 Redundancy group identifier.
Example: 5c0e9384-aa79-4ec9-b7a2-557f8c307292
priority string
 Relative priority in a redundancy group.
Example:
  • PRIMARY
  • SECONDARY
isRemote boolean
 Indicates if both connection endpoints are in the same location.
Example: false
direction string
 Direction of the connection (from the requester's point of view).
Example: OUTGOING
aSide object
 Source port definition.
accessPoint object
 Connection endpoint configuration.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
  • VD - Network Edge virtual device.
  • CLOUD_ROUTER - Fabric Cloud Router instance.
  • NETWORK - Fabric network that enables creating multipoint connections.
  • METAL_NETWORK - Metal instance.
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId integer
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
location object
 Port associated with the connection.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
port object
 Port associated with the connection.
href string
 An absolute URL that returns the specified port.
Example:https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid string
 Equinix-assigned port identifier.
Example:
name string
 Equinix-assigned port name.
Example: 272010-SV5-CX-Secondary-01
redundancy object
 Port redundancy information.
priority string
 Relative port priority.
Example: SECONDARY
linkProtocol object
 Link protocol configuration.
Applicable to COLO and VD type access points.
type string
 Link protocol type.
Example:
  • DOT1Q
  • QINQ
  • UNTAGGED
vlanTag integer
 DOT1Q protocol VLAN tag.
Example: 222
vlanSTag integer
 QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTag integer
 QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
Example: 333
router object
 Port associated with the connection.
href string
 Absolute URL that returns the specified entity.
Example:http://api.equinix.com/fabric/v4/routers/bb818900-d4b4-445a-85a2-cecd88061662
uuid string
 Fabric Cloud Router identifier.
Example: bb818900-d4b4-445a-85a2-cecd88061662
name string
 Fabric Cloud Router name.
Example: E2E-API-FG
serviceToken object
 Service token specification.
Applicable to connections that use A-side service tokens.
uuid string
 Service token identifier.
Example: e05f4f23-d098-4d7c-a9ca-c2897b465107
zSide object
 Destination port definition.
accessPoint object
 Connection endpoint configuration.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
  • SP - Service profile.
  • VD - Network Edge virtual device.
  • NETWORK - Fabric network that enables creating multipoint connections.
  • METAL_NETWORK - Metal instance.
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId string
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
location object
 Port associated with the connection.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
port object
 Port associated with the connection.
href string
 An absolute URL that returns the specified port.
Example:https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid string
 Equinix-assigned port identifier.
Example:
name string
 Equinix-assigned port name.
Example: 272010-SV5-CX-Secondary-01
redundancy object
 Port redundancy information.
priority string
 Relative port priority.
Example: SECONDARY
linkProtocol object
 Link protocol configuration.
Applicable to COLO and VD type access points.
type string
 Link protocol type.
Example:
  • DOT1Q
  • QINQ
  • UNTAGGED
vlanTag integer
 DOT1Q protocol VLAN tag.
Example: 222
vlanTagMin integer
 DOT1Q protocol VLAN tag range lowest value. Applicable to connections originating from Network Edge devices. Required if vlanTag isn't specified.
Example: 222
vlanTagMax integer
 DOT1Q protocol VLAN tag range highest value. Applicable to connections originating from Network Edge devices. Required if vlanTag isn't specified.
Example: 333
vlanSTag integer
 QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTag integer
 QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTagMin integer
 QINQ protocol lowest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if vlanCTag isn't specified.
Example: 222
vlanCTagMax integer
 QINQ protocol highest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if vlanCTag isn't specified.
Example: 333
profile object
 A named provider service and its network connectivity requirements.
Applicable to SP type access points.

Use the Retrieve Service Profiles API request to search for service profiles and determine their identifiers and available locations.
type string
 Service profile type.
Example: L2_PROFILE
uuid string
 Service profile identifier.
Example: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c
location object
 Connection endpoint location information.
Applicable to SP type access points.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
network object
 Fabric network instance information. Applicable to NETWORK type access points.
uuid string
 Equinix-assigned Fabric network instance identifier.
Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
name string
 Network name.
Example: EPLAN-GLOBAL-1017a
type string
 Network type.
Example: EPLAN
scope string
 Network geographic scope.
Example: GLOBAL
serviceToken object
 Service token specification.
Applicable to connections that use Z-side service tokens.
uuid string
 Service token identifier.
Example: e05f4f23-d098-4d7c-a9ca-c2897b465107

Manage Connection

POST /fabric/v4/connections/{uuid}/actions
Method POST
URL or Endpoint /fabric/v4/connections/{uuid}/actions
Headers Authorization, Content-Type
Path Parameters uuid
Query Parameters Not applicable
Body Parameters type, data, description

This API enables:

  • Approving connections
  • Rejecting connections
  • Approving connection bandwidth change
  • Rejecting connection bandwidth change
  • Accepting connection deletion
  • Triggering BGP synchronization (applicable to Microsoft Azure connections)
  • Fetching latest bandwidth from provider

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


Sample curl request - approve connection

Copy 
curl -X
                        POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/actions'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '{
                        "type": "CONNECTION_CREATION_ACCEPTANCE",
                        "data": {
                        "zSide": {
                        "accessPoint": {
                        "type": "COLO",
                        "port": {
                        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
                        },
                        "linkProtocol": {
                        "type": "QINQ",
                        "vlanSTag": 1002,
                        "vlanCTag": 1001
                        }
                        }
                        }
                        }
                    }'

Sample curl request - reject connection

Copy 
curl -X
                        POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/actions'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '{
                        "type": "CONNECTION_CREATION_REJECTION",
                        "description": "Invalid connection update request"
                    }'

Sample curl request - approve connection bandwidth update

Copy 
curl -X
                        POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/actions'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '{
                        "type": "CONNECTION_UPDATE_ACCEPTANCE"
                    }'

Sample curl request - reject connection bandwidth update

Copy 
curl -X
                        POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/actions'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '{
                        "type": "CONNECTION_UPDATE_REJECTION",
                        "description": "Invalid connection update request"
                    }'

Sample curl request - accept connection deletion

Copy 
curl -X
                        POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/actions'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '{
                        "type": "CONNECTION_DELETION_ACCEPTANCE"
                    }'

Sample curl request - trigger Microsoft Azure connection BGP synchronization

Copy 
curl -X
                        POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/actions'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '{
                        "type": "CONNECTION_PROVIDER_STATUS_REQUEST"
                    }'

Sample curl request - fetching latest bandwidth from provider

Copy 
curl -X
                        POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/actions'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '{
                        "type": "CONNECTION_PROVIDER_BANDWIDTH_REQUEST"
                    }'

Path parameters

Parameter
Description
uuid string
REQUIRED
 Equinix-assigned connection identifier.

Body parameters

Parameter
Description
type string
REQUIRED
 Connection management action.
Applicable values:
  • CONNECTION_CREATION_ACCEPTANCE - Approve pending connection.
  • CONNECTION_CREATION_REJECTION - Reject pending connection.
  • CONNECTION_UPDATE_ACCEPTANCE - Approve bandwidth update.
  • CONNECTION_UPDATE_REJECTION - Reject bandwidth update.
  • CONNECTION_DELETION_ACCEPTANCE - Accept connection deletion.
  • CONNECTION_PROVIDER_STATUS_REQUEST - Send BGP synchronization request.
  • CONNECTION_PROVIDER_BANDWIDTH_REQUEST - fetch the latest bandwidth from provider.
Note that the action type determines the list of applicable body parameters.
description object
REQUIRED
 Rejection reason.
Applicable to CONNECTION_UPDATE_REJECTION action type.
Example: Invalid connection update request.
data string
CONDITIONAL
 Additional data related to the connection action type.
Applicable to CONNECTION_CREATION_ACCEPTANCE action type.
zSide object
REQUIRED
 Z-side (provider) connection configuration.
accessPoint object
REQUIRED
 Connection endpoint configuration.
type string
REQUIRED
 Connection endpoint type.
Applicable values:
  • COLO - Colocation space in an IBX data center.
port object
REQUIRED
 Port associated with the connection.
uuid string
REQUIRED
 Equinix-assigned port identifier.
Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
linkProtocol object
REQUIRED
 Link protocol configuration.
type string
REQUIRED
 Link protocol type.
Applicable values:
  • DOT1Q
  • QINQ
vlanTag integer
REQUIRED
 DOT1Q protocol VLAN tag.
Applicable values:
  • Minimum: 2
  • Maximum: 4094
vlanSTag integer
REQUIRED
 QINQ protocol outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Applicable values:
  • Minimum: 2
  • Maximum: 4094
vlanCTag integer
REQUIRED
 QINQ protocol inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
Applicable values:
  • Minimum: 2
  • Maximum: 4094

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


Sample response - approve connection

Copy 
{
                        "href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
                        "type": "EVPL_VC",
                        "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
                        "name": "Conn-Name-2",
                        "state": "PROVISIONED",
                        "order": {
                        "purchaseOrderNumber": "1-129105284100",
                        "billingTier": "Up to 1 Gbps"
                        },
                        "bandwidth": 1000,
                        "change": {
                        "uuid": "da6a1a0b-0872-4c06-b9d7-5c8ee3056775",
                        "type": "CONNECTION_CREATION",
                        "status": "APPROVED",
                        "createdDateTime": "2021-12-12T06:00:01.183Z",
                        },
                        "redundancy": {
                        "group": "m167f685-41b0-1b07-6de0-320a5c00abeu",
                        "priority": "PRIMARY"
                        },
                        "aSide": {
                        "accessPoint": {
                        "type": "COLO",
                        "port": {
                        "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                        "type": "XF_PORT",
                        "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
                        },
                        "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 1001
                        }
                        }
                        },
                        "zSide": {
                        "accessPoint": {
                        "type": "SP",
                        "profile": {
                        "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                        "type": "L2_Profile",
                        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
                        },
                        "location": {
                        "href": "https://api.equinix.com/v4/metros/SV",
                        "metrocode": "SV",
                        "region": "AMER"
                        },
                        "port": {
                        "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-5ae1-ae10-8ce0-306a5c00a4ee",
                        "uuid": "c791f8cb-5ae1-ae10-8ce0-306a5c00a4ee",
                        "name": "testBuyer-FR4-L-Dot1q-STD-PRI-10G-JN-489"
                        },
                        "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 837
                        }
                        }
                        },
                        "notifications": [
                        {
                        "type": "ALL",
                        "emails": [
                        "test@equinix.com",
                        "test@equinix.com"
                        ]
                        }
                        ],
                        "operation": {
                        "equinixStatus": "PROVISIONED",
                        "providerStatus": "PROVISIONED"
                        },
                        "changeLog": {
                        "createdDateTime": "2021-07-15T19:30:29.526Z",
                        "updatedDateTime": "2021-08-15T19:30:29.526Z",
                        }
                    }

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified connection.
Example:https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62
type string
 Connection type.
Example:
  • EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections.
  • EPL_VC - Ethernet private line connection type used for untagged layer 2 connections.
  • ACCESS_EPL_VC - E-access, layer 2 connection between a QINQ port and an EPL port.
  • IP_VC - Layer 2 connection between a Fabric Cloud Router instance and a port.
  • EVPLAN_VC - Ethernet virtual private local area network connection for DOT1Q ports or virtual devices.
uuid string
 Equinix-assigned connection identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
name string
 Connection name.
Example: my_connection
state string
 Lifecycle stage of a connection.
Example: PROVISIONED
order object
 Order details.
purchaseOrderNumber string
 Subscriber's purchase order identifier.
Example: 1-129105284100
billingTier string
 Billing tier for connection bandwidth.
Example: Up to 1 Gbps
bandwidth integer
 Connection bandwidth in Mbps.
Example:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
change object
 Connection update details.
uuid string
 Connection change identifier.
Example: da6a1a0b-0872-4c06-b9d7-5c8ee3056775
type string
 Connection change action.
Example: CONNECTION_CREATION
status string
 Connection change status.
Example: APPROVED
createdDateTime string
 Connection change creation timestamp in the IETF ISO 8601 extended date/time format:
Example: 2021-07-15T19:30:29.526Z
redundancy object
 Connection redundancy configuration.
group string
 Redundancy group identifier.
Example: 5c0e9384-aa79-4ec9-b7a2-557f8c307292
priority string
 Relative priority in a redundancy group.
Example:
  • PRIMARY
  • SECONDARY
operation object
 Connection type-specific operational data.
equinixStatus string
 Progress towards provisioning a specified connection.
Example: PROVISIONING
providerStatus string
 Provider's progress towards provisioning a specified connection.
Example: NOT_AVAILABLE
notifications array[object]
 Notification settings for messages related to the asset configuration or its status.
type string
 Notification messages category.
Example:
  • ALL
emails array[string]
 Email addresses of up to 12 recipients.
Example: ["mike@mspp.com","dwight@dm.com"]
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId integer
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
updatedBy string
 Identity of the person who updated the asset.
Example: AverageJoe
updatedDateTime string
 Asset update request timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
bandwidth integer
 Connection bandwidth in Mbps.
Example:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
isRemote boolean
 Indicates if both connection endpoints are in the same location.
Example: false
direction string
 Direction of the connection (from the requester's point of view).
Example: OUTGOING
aSide object
 Source port definition.
accessPoint object
 Connection endpoint configuration.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
  • VD - Network Edge virtual device.
  • CLOUD_ROUTER - Fabric Cloud Router instance.
  • NETWORK - Fabric network that enables creating multipoint connections.
  • METAL_NETWORK - Metal instance.
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId integer
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
location object
 Port associated with the connection.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
port object
 Port associated with the connection.
href string
 An absolute URL that returns the specified port.
Example:https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid string
 Equinix-assigned port identifier.
Example:
name string
 Equinix-assigned port name.
Example: 272010-SV5-CX-Secondary-01
redundancy object
 Port redundancy information.
priority string
 Relative port priority.
Example: SECONDARY
linkProtocol object
 Link protocol configuration.
Applicable to COLO and VD type access points.
type string
 Link protocol type.
Example:
  • DOT1Q
  • QINQ
  • UNTAGGED
vlanTag integer
 DOT1Q protocol VLAN tag.
Example: 222
vlanSTag integer
 QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTag integer
 QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
Example: 333
virtualDevice object
 Virtual device configuration.
Applicable to VD type access points.
type string
 Equinix-assigned virtual device identifier.
  • EDGE
uuid string
 Virtual device instance identifier.
interface object
 Interface configuration.
Applicable to VD type access points.
type string
 Virtual device network interface type.
Example:
  • NETWORK
  • CLOUD
id integer
 Virtual device network interface identifier.
Example: 544211
router object
 Port associated with the connection.
href string
 Absolute URL that returns the specified entity.
Example:http://api.equinix.com/fabric/v4/routers/bb818900-d4b4-445a-85a2-cecd88061662
uuid string
 Fabric Cloud Router identifier.
Example: bb818900-d4b4-445a-85a2-cecd88061662
name string
 Fabric Cloud Router name.
Example: E2E-API-FG
serviceToken object
 Service token specification.
Applicable to connections that use A-side service tokens.
uuid string
 Service token identifier.
Example: e05f4f23-d098-4d7c-a9ca-c2897b465107
zSide object
 Destination port definition.
accessPoint object
 Connection endpoint configuration.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
  • SP - Service profile.
  • VD - Network Edge virtual device.
  • NETWORK - Fabric network that enables creating multipoint connections.
  • METAL_NETWORK - Metal instance.
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId string
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
location object
 Port associated with the connection.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
port object
 Port associated with the connection.
href string
 An absolute URL that returns the specified port.
Example:https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid string
 Equinix-assigned port identifier.
Example:
name string
 Equinix-assigned port name.
Example: 272010-SV5-CX-Secondary-01
redundancy object
 Port redundancy information.
priority string
 Relative port priority.
Example: SECONDARY
linkProtocol object
 Link protocol configuration.
Applicable to COLO and VD type access points.
type string
 Link protocol type.
Example:
  • DOT1Q
  • QINQ
  • UNTAGGED
vlanTag integer
 DOT1Q protocol VLAN tag.
Example: 222
vlanTagMin integer
 DOT1Q protocol VLAN tag range lowest value. Applicable to connections originating from Network Edge devices. Required if vlanTag isn't specified.
Example: 222
vlanTagMax integer
 DOT1Q protocol VLAN tag range highest value. Applicable to connections originating from Network Edge devices. Required if vlanTag isn't specified.
Example: 333
vlanSTag integer
 QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTag integer
 QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTagMin integer
 QINQ protocol lowest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if vlanCTag isn't specified.
Example: 222
vlanCTagMax integer
 QINQ protocol highest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if vlanCTag isn't specified.
Example: 333
profile object
 A named provider service and its network connectivity requirements.
Applicable to SP type access points.

Use the Retrieve Service Profiles API request to search for service profiles and determine their identifiers and available locations.
type string
 Service profile type.
Example: L2_PROFILE
uuid string
 Service profile identifier.
Example: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c
location object
 Connection endpoint location information.
Applicable to SP type access points.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
network object
 Fabric network instance information. Applicable to NETWORK type access points.
uuid string
 Equinix-assigned Fabric network instance identifier.
Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
name string
 Network name.
Example: EPLAN-GLOBAL-1017a
type string
 Network type.
Example: EPLAN
scope string
 Network geographic scope.
Example: GLOBAL
serviceToken object
 Service token specification.
Applicable to connections that use Z-side service tokens.
uuid string
 Service token identifier.
Example: e05f4f23-d098-4d7c-a9ca-c2897b465107

Sample response - fetching the latest bandwidth from provider

Copy 
{
                        "type": "CONNECTION_PROVIDER_BANDWIDTH_REQUEST",
                        "data": {
                        "providerBandwidth": 500
                        },
                        "changeLog": {
                        "createdDateTime": "2024-07-10T21:58:51.581Z",
                        "updatedDateTime": "2024-07-10T21:58:51.581Z"
                        }
                    

Response payload body description - fetching the latest bandwidth from provider

Parameter
Description
type string
 Connection change action.
Example: CONNECTION_PROVIDER_BANDWIDTH_REQUEST
data object
 Object with result set.
providerBandwidth integer
 Bandwidth configured on the provider token. This may be different from (usually equal or greater than) the bandwidth utilized on the connection.
Example: 2GB
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z

Delete Connection

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

This API request deletes a specified connection.

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


Sample curl request

Copy 
curl -X
                        DELETE 'https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
                    -H 'authorization: Bearer qwErtY8zyW1abcdefGHI

Path parameters

Parameter
Description
uuid string
REQUIRED
 Equinix-assigned connection identifier.

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


Sample response

Copy 
{
                        "href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
                        "type": "EVPL_VC",
                        "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
                        "name": "Conn-1",
                        "state": "DEPROVISIONING",
                        "order": {
                        "purchaseOrderNumber": "1-129105284100",
                        "billingTier": "Up to 1 Gbps"
                        },
                        "bandwidth": 1000,
                        "redundancy": {
                        "group": "m167f685-41b0-1b07-6de0-320a5c00abeu",
                        "priority": "PRIMARY"
                        },
                        "aSide": {
                        "accessPoint": {
                        "type": "COLO",
                        "port": {
                        "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                        "type": "XF_PORT",
                        "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
                        },
                        "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 1001
                        }
                        }
                        },
                        "zSide": {
                        "accessPoint": {
                        "type": "SP",
                        "profile": {
                        "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                        "type": "L2_Profile",
                        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
                        },
                        "location": {
                        "href": "https://api.equinix.com/v4/metros/SV",
                        "metrocode": "SV",
                        "region": "AMER"
                        }
                        }
                        },
                        "notifications": [
                        {
                        "type": "ALL",
                        "emails": [
                        "test@equinix.com",
                        "test@equinix.com"
                        ]
                        }
                        ],
                        "operation": {
                        "equinixStatus": "DEPROVISIONING",
                        "providerStatus": "DEPROVISIONING"
                        },
                        "changeLog": {
                        "createdDateTime": "2021-07-15T19:30:29.526Z",
                        "deletedDateTime": "2021-08-15T11:10:19.516Z"
                        }
                    }

Response payload body description

Parameter
Description
type string
 Connection type.
Example:
  • EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections.
  • EPL_VC - Ethernet private line connection type used for untagged layer 2 connections.
  • ACCESS_EPL_VC - E-access, layer 2 connection between a QINQ port and an EPL port.
  • IP_VC - Layer 2 connection between a Fabric Cloud Router instance and a port.
  • EVPLAN_VC - Ethernet virtual private local area network connection for DOT1Q ports or virtual devices.
href string
 An absolute URL that returns the specified connection.
Example:https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid string
 Equinix-assigned connection identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
name string
 Connection name.
Example: my_connection
state string
 Lifecycle stage of a connection.
Example: DEPROVISIONING
operation object
 Connection type-specific operational data.
equinixStatus string
 Progress towards provisioning a specified connection.
Example: PROVISIONING
providerStatus string
 Provider's progress towards provisioning a specified connection.
Example: NOT_AVAILABLE
order object
 Order details.
purchaseOrderNumber string
 Subscriber's purchase order identifier.
Example: 1-129105284100
billingTier string
 Billing tier for connection bandwidth.
Example: Up to 1 Gbps
notifications array[object]
 Notification settings for messages related to the asset configuration or its status.
type string
 Notification messages category.
Example:
  • ALL
emails array[string]
 Email addresses of up to 12 recipients.
Example: ["mike@mspp.com","dwight@dm.com"]
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId integer
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
bandwidth integer
 Connection bandwidth in Mbps.
Example:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
redundancy object
 Connection redundancy configuration.
group string
 Redundancy group identifier.
Example: 5c0e9384-aa79-4ec9-b7a2-557f8c307292
priority string
 Relative priority in a redundancy group.
Example:
  • PRIMARY
  • SECONDARY
isRemote boolean
 Indicates if both connection endpoints are in the same location.
Example: false
direction string
 Direction of the connection (from the requester's point of view).
Example: OUTGOING
aSide object
 Source port definition.
accessPoint object
 Connection endpoint configuration.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
  • VD - Network Edge virtual device.
  • CLOUD_ROUTER - Fabric Cloud Router instance.
  • NETWORK - Fabric network that enables creating multipoint connections.
  • METAL_NETWORK - Metal instance.
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId integer
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
location object
 Port associated with the connection.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
port object
 Port associated with the connection.
href string
 An absolute URL that returns the specified port.
Example:https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid string
 Equinix-assigned port identifier.
Example:
name string
 Equinix-assigned port name.
Example: 272010-SV5-CX-Secondary-01
redundancy object
 Port redundancy information.
priority string
 Relative port priority.
Example: SECONDARY
linkProtocol object
 Link protocol configuration.
Applicable to COLO and VD type access points.
type string
 Link protocol type.
Example:
  • DOT1Q
  • QINQ
  • UNTAGGED
vlanTag integer
 DOT1Q protocol VLAN tag.
Example: 222
vlanSTag integer
 QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTag integer
 QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
Example: 333
virtualDevice object
 Virtual device configuration.
Applicable to VD type access points.
type string
 Equinix-assigned virtual device identifier.
  • EDGE
uuid string
 Virtual device instance identifier.
interface object
 Interface configuration.
Applicable to VD type access points.
type string
 Virtual device network interface type.
Example:
  • NETWORK
  • CLOUD
id integer
 Virtual device network interface identifier.
Example: 544211
router object
 Port associated with the connection.
href string
 Absolute URL that returns the specified entity.
Example:http://api.equinix.com/fabric/v4/routers/bb818900-d4b4-445a-85a2-cecd88061662
uuid string
 Fabric Cloud Router identifier.
Example: bb818900-d4b4-445a-85a2-cecd88061662
name string
 Fabric Cloud Router name.
Example: E2E-API-FG
serviceToken object
 Service token specification.
Applicable to connections that use A-side service tokens.
uuid string
 Service token identifier.
Example: e05f4f23-d098-4d7c-a9ca-c2897b465107
zSide object
 Destination port definition.
accessPoint object
 Connection endpoint configuration.
type string
 Connection endpoint type.
Example:
  • COLO - Colocation space in an IBX data center.
  • SP - Service profile.
  • VD - Network Edge virtual device.
  • NETWORK - Fabric network that enables creating multipoint connections.
  • METAL_NETWORK - Metal instance.
account object
 Customer account information.
accountNumber integer
 Equinix-assigned account number.
Example: 270106
orgId string
 Equinix-assigned organization identifier.
Example: 92362
globalOrgId string
 Equinix-assigned top-level organization identifier.
Example: 0016u000003JZ62AAG
location object
 Port associated with the connection.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
port object
 Port associated with the connection.
href string
 An absolute URL that returns the specified port.
Example:https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid string
 Equinix-assigned port identifier.
Example:
name string
 Equinix-assigned port name.
Example: 272010-SV5-CX-Secondary-01
redundancy object
 Port redundancy information.
priority string
 Relative port priority.
Example: SECONDARY
linkProtocol object
 Link protocol configuration.
Applicable to COLO and VD type access points.
type string
 Link protocol type.
Example:
  • DOT1Q
  • QINQ
  • UNTAGGED
vlanTag integer
 DOT1Q protocol VLAN tag.
Example: 222
vlanTagMin integer
 DOT1Q protocol VLAN tag range lowest value. Applicable to connections originating from Network Edge devices. Required if vlanTag isn't specified.
Example: 222
vlanTagMax integer
 DOT1Q protocol VLAN tag range highest value. Applicable to connections originating from Network Edge devices. Required if vlanTag isn't specified.
Example: 333
vlanSTag integer
 QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTag integer
 QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222
vlanCTagMin integer
 QINQ protocol lowest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if vlanCTag isn't specified.
Example: 222
vlanCTagMax integer
 QINQ protocol highest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if vlanCTag isn't specified.
Example: 333
profile object
 A named provider service and its network connectivity requirements.
Applicable to SP type access points.

Use the Retrieve Service Profiles API request to search for service profiles and determine their identifiers and available locations.
type string
 Service profile type.
Example: L2_PROFILE
uuid string
 Service profile identifier.
Example: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c
location object
 Connection endpoint location information.
Applicable to SP type access points.
region string
 Broad geographic area in which a specified Equinix asset is located.
Example: EMEA
metroName string
 Metropolitan area name.
Example: Brussels
metroCode string
 Metropolitan area identifier.
Example: BL
network object
 Fabric network instance information. Applicable to NETWORK type access points.
uuid string
 Equinix-assigned Fabric network instance identifier.
Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
name string
 Network name.
Example: EPLAN-GLOBAL-1017a
type string
 Network type.
Example: EPLAN
scope string
 Network geographic scope.
Example: GLOBAL
serviceToken object
 Service token specification.
Applicable to connections that use Z-side service tokens.
uuid string
 Service token identifier.
Example: e05f4f23-d098-4d7c-a9ca-c2897b465107

Validate Connection Authorization Key

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

This API request validates the authorization key required for establishing connections to cloud service providers.

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/connections/validate'
                        -H 'content-type: application/json'
                        -H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
                        -d '{
                        "filter": {
                        "and": [
                        {
                        "property": "/zSide/accessPoint/authenticationKey",
                        "operator": "=",
                        "values": [
                        "xx-xx-xx"
                        ]
                        },
                        {
                        "property": "/zSide/accessPoint/profile/uuid",
                        "operator": "=",
                        "values": [
                        "20d32a80-0d61-4333-bc03-707b591ae2f5"
                        ]
                        },
                        {
                        "property": "/zSide/accessPoint/sellerRegion",
                        "operator": "=",
                        "values": [
                        "us-west1"
                        ]
                        }
                        ]
                        }
                    }'

Body parameters

Parameter
Description
filter object
REQUIRED
 Object containing Z-side access point parameters for validation.
and array[object]
REQUIRED
 Array of access point parameters.
property string
REQUIRED
 Access point parameter.
Applicable values:
  • /zSide/accessPoint/authenticationKey
  • /zSide/accessPoint/profile/uuid
  • /zSide/accessPoint/sellerRegion
operator string
REQUIRED
 Parameter operator.
Applicable values:
  • =
values string
REQUIRED
 Parameter value.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
/zSide/accessPoint/authenticationKey Example:
"property": "/zSide/accessPoint/authenticationKey",
"operator": "=",
"values": [
"xx-xx-xx"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
value array[string]
REQUIRED
 Connection name.
Example: ["xx-xx-xx"]
/zSide/accessPoint/profile/uuid Example:
"property": "/zSide/accessPoint/profile/uuid",
"operator": "=",
"values": [
"3a58dd05-f46d-4b1d-a154-2e85c396ea62
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
value array[string]
REQUIRED
 Equinix-assigned service profile identifier.
Example: ["3a58dd05-f46d-4b1d-a154-2e85c396ea62"]
/zSide/accessPoint/sellerRegion Example:
"property": "/zSide/accessPoint/sellerRegion",
"operator": "=",
"values": [
"us-west1"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
value array[string]
REQUIRED
 Service provider region.
Not applicable to connections to Microsoft Azure.
Example: ["us-west1"]

Sample response - validate connection to Microsoft Azure

Copy 
{
                        "additionalInfo": [
                        {
                        "key": "message",
                        "value": "Authorization key provided is valid"
                        }
                        ],
                        "data": [
                        {
                        "bandwidth": 500,
                        "redundancy": {
                        "priority": "PRIMARY"
                        },
                        "zSide": {
                        "accessPoint": {
                        "type": "COLO",
                        "port": {
                        "type": "XF_PORT",
                        "name": "SIN-TEST-EQIX-06GMR-CIS-1-PRI-A"
                        },
                        "linkProtocol": {
                        "type": "QINQ",
                        "vlanSTag": 1003
                        }
                        }
                        }
                        },
                        {
                        "bandwidth": 500,
                        "redundancy": {
                        "priority": "SECONDARY"
                        },
                        "zSide": {
                        "accessPoint": {
                        "type": "COLO",
                        "port": {
                        "type": "XF_PORT",
                        "name": "SIN-TEST-EQIX-06GMR-CIS-1-PRI-2"
                        },
                        "linkProtocol": {
                        "type": "QINQ",
                        "vlanSTag": 1003
                        }
                        }
                        }
                        }
                        ]
                    }

Response payload body description

Parameter
Description
additionalInfo array[object]
 An array of key-value pair objects containing additional information.
key string
 Additional information key parameter.
Example: message
value string
 Validation result message.
Example: Authorization key provided is valid
data array[object]
 Data array containing connection properties.
bandwidth integer
 Connection bandwidth in Mbps.
Example: 500
redundancy object
 Connection redundancy configuration.
priority string
 Relative priority in a redundancy group.
Example: PRIMARY
zSide object
 Destination port definition.
accessPoint object
 Connection endpoint configuration.
type string
 Connection endpoint type.
Example: COLO - Colocation space in an IBX data center.
port object
 Port associated with the connection.
name string
 Equinix-assigned port name.
Example: 272010-SV5-CX-Secondary-01
linkProtocol object
 Link protocol configuration.
Applicable to COLO and VD type access points.
type string
 Link protocol type.
Example:
  • DOT1Q
  • QINQ
  • UNTAGGED
vlanTag integer
 DOT1Q protocol VLAN tag.
Example: 222
vlanSTag integer
 QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines.
Example: 222