Skip to main content
Index

Layer 2 Buyer APIs (V2-Deprecated)

GET Ports

Note: This API has been deprecated and replaced by GET /ecx/v3/port/userport. Refer to GET userport under the API Reference section for more information.

 

GET /v2/ports

 Method  GET
 URL or End Point  /ecx/v2/ports
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  Not applicable

 

The ports API returns the details of all assigned and available ports for the user credentials submitted. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed. 

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshots show a sample curl request to obtain all designated ports, and its respective JSON response containing the port information.

 

curl -X

GET "https://api.equinix.com/ecx/v2/ports"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

{
  "ports": [
    {
      "name": "JohnDoePort",
      "bandwidths": [
        "10 G"
      ],
      "is_buyout": "N",
      "ibx_name": "DC5",
      "layer3": "Y",
      "metro_code": "DC",
      "metro_name": "Ashburn",
      "port_group": "1",
      "port_priority": "Primary",
      "encapsulation": "Dot1q",
      "cross_connect_ids": [
        "2456963"
      ]
    }
  ]
}

 

Pay attention to the metroCode attribute received in the response, as this indicates where the connection would be established from. This can be cross-referenced with the response from /ecx/v2/metros API to discover all the available metros where the user can connect to.

 

The description of the response payload is as follows:

 

Field Name Type Example Description
ports array [string]   An array containing multiple port information.
name string JohnDoePort The name assigned to the port.
bandwidths array

10 G

An array containing the supported port bandwidths.

is_buyout string

N

Indicates whether the port is a buyout port. If the value is "Y", then it is an unlimited connections port that allows multiple connections on the port at no additional charge. If the value is "N" then it is a standard port.
ibx_name string DC5 The IBX in which the port resides.
layer3 string Y Indicates whether the port supports layer 3 connections.
metro_code boolean

DC

The metro code where the port resides.
metro_name string Ashburn The metro name where the port resides.
port_group string 1 The Group id/number of the device where the port resides.
port_priority string

Primary

The priority of the device (Primary/secondary).
encapsulation string Dot1q The VLAN encapsulation of the port (Dot1q or QinQ).
cross_connect_ids string 2456963 Cross-connect ID associated with the port.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

GET Ports {port_name}

Note: This API has been deprecated and replaced by GET /ecx/v3/port/userport. Refer to GET userport under the API Reference section for more information.

 

GET /v2/ports/{port_name}

 Method  GET
 URL or End Point  /ecx/v2/ports/{port_name}
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  Not applicable

 

The ports API returns the details of a given port name. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshots show a sample curl request and its JSON response to obtain the port details for the port name JohnDoeDemoPort. 

 

curl -X

GET "https://api.equinix.com/ecx/v2/ports/JohnDoeDemoPort"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

The description of the URL parameter is as follows:

 

URL Parameter Name Mandatory Type Example Applicable Values Description
port_name Yes string JohnDoeDemoPort

 

Name of the port owned by the user.
 

 

{
  "ports": [
    {
      "name": "JohnDoePort",
      "bandwidths": [
        "10 G"
      ],
      "is_buyout": "Y",
      "ibx_name": "SV4",
      "layer3": "Y",
      "metro_code": "SV",
      "metro_name": "Silicon Valley",
      "port_group": "1",
      "port_priority": "Primary",
      "encapsulation": "Dot1q",
      "cross_connect_ids": [
        "21063683-A"
      ]
    }
  ],
  "port_clusters": [
    [
      "John-Doe-SERVICES-SV4-CX-PRI-03"
    ]
  ]
}

 

The description of the response payload is as follows:

 

Field Name Type Example Description
ports array [string]   An array containing multiple port information.
name string JohnDoePort The name assigned to the port.
bandwidths array

10 G

An array containing the supported port bandwidths.

is_buyout string

N

Indicates whether the port is a buyout port. If the value is "Y", then it is an unlimited connections port that allows multiple connections on the port at no additional charge. If the value is "N" then it is a standard port.
ibx_name string DC5 The IBX in which the port resides.
layer3 string Y Indicates whether the port supports layer 3 connections.
metro_code boolean

DC

The metro code where the port resides.
metro_name string Ashburn The metro name where the port resides.
port_group string 1 The Group id/number of the device where the port resides.
port_priority string

Primary

The priority of the device (Primary/secondary).
encapsulation string Dot1q The VLAN encapsulation of the port (Dot1q or QinQ).
cross_connect_ids string 2456963 Cross-connect ID associated with the port
port_clusters array [string] John-Doe-SERVICES-SV4-CX-PRI-03 An array containing the different ports associated with this port.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

GET Metros

Note: This API has been deprecated and replaced by GET /ecx/v3/l2/common/metros. Refer to GET metros under the API Reference section for more information.

 

GET /v2/metros

 Method  GET
 URL or End Point  /ecx/v2/metros
 Headers  Authorization, Content-Type
 Query Parameters  cloud_exchange_enabled, port_availalable
 Body  Not applicable

 

The GET Metros call returns all available metros with configured Equinix Fabric ports to which the user can connect. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshots show a sample curl request and JSON response for this API. The response indicates that a user can connect to Amsterdam (AM), Warsaw (WA) and Zurich (ZH).

 

curl -X

GET "https://api.equinix.com/ecx/v2/metros"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

The description of the query parameters are as follows:

 

Query Parameter Name Mandatory Type Example Applicable Values Description
clooud_exchange_enabled No String  

true

false

Used for filtering the results to get the metros where Cloud Exchange is enabled. If this parameter is not included the result will contain all the metros where the user has ports or Cloud Exchange is enabled 
port_available No String     Used for filtering the results to get the metros where the user has ports. If this parameter is not included the result will contain all the metros where the user has ports or Cloud Exchange is enable

 

{
  "metros": [
    {
      "name": "Amsterdam",
      "code": "AM"
    },
    {
      "name": "Warsaw",
      "code": "WA"
    },
    {
      "name": "Zurich",
      "code": "ZH"
    }
  ]
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
metros array   An array containing all the available metros to which connections can be made.
name string Amsterdam The name of the metro. 
code string AM The two-character code used to denote the metro.

 

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

GET V2 Seller Services

Note: This API has been deprecated and replaced by GET /ecx/v3/l2/serviceprofiles/services. Refer to GET L2 service profiles services under the API Reference section for more information.

 

GET v2/sellerservices

 Method  GET
 URL or End Point  /ecx/v2/sellerservices
 Headers  Authorization, Content-Type
 Query Parameters  metroCode, pageNumber, pageSize
 Body  Not applicable

 

The services API returns all layer 2 seller profiles (services) such as AWS - Direct Connect, Azure - Express Route, etc for a given metro. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshots show a sample curl request to obtain details of layer 2 sellers within SV, USA and a JSON response containing details of a sample seller named John-Doe-Services. 

 

curl -X

GET "https://api.equinix.com/ecx/v2/sellerservices?metro_code=SV"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

The description of the query parameters are as follows:

 

Query Parameter Name Mandatory Type Example Applicable Values Description
metro_code No array[string]

SV

 

The 2 character metro code of the metro for which to retrieve service profiles. If this parameter is not included, the response will contain all the seller services at Equinix.

 

{
  "seller_services": [
    {
      "name": "John-Doe-Services",
      "metros": [
        {
          "availability_status": "In Trail testing",
          "code": "CH",
          "ibxs": [
            "CH2"
          ],
          "name": "Chicago"
        }
      ],
      "allow_custom_speed": "N",
      "standard_speeds": [
        "Up to 50MB",
        "Up to 200MB",
        "Up to 500MB",
        "Up to 1000MB"
      ],
      "require_redundancy": "N",
      "encapsulation": "Dot1q",
      "service_summary": "",
      "service_type": "Layer 2 Cloud Service Connectivity",
      "bgp_community_tag": "",
      "req_buyer_ip_prefixes": "",
      "ipsec_nat_traversal_support": ""
    }
  ]
}

 

The description of the response payload is as follows:

 

Field  Name Type Example Description
seller_services array[objects]   An array containing the details of the seller service profiles available.
name string John-Doe-Services The name assigned to the service profile.
metros array[objects]   An array containing the metro details associated with this profile where connections can be created.
availability_status string In Trail testing Indicates the availability and reliability of the service profile. In other words, this indicates whether the service offered is in beta, limited availability or GA.
code string CH The metro code denoting metros where connections to this service profile can be created.
ibxs array [string] CH2 An array containing the Equinix IBXs associated with this metro.
name string Chicago The name of the metro.
allow_custom_speed string N Indicates whether or not to allow custom bandwidths/speeds to be defined when creating connections to this profile.
standard_speeds array[string] Up to 50MB An array containing the speeds/bandwidth ranges allowed when creating connections to this profile.
require_redundancy string N Specify if your connections require redundancy. If yes, then users need to create a secondary redundant connection.
encapsulation string Dot1q The port encapsulation type for this profile, can be either Dot1q or Qinq.
service_summary string   A summary of the service profile.
service_type string Layer 2 Cloud Service Connectivity The service type supported by this service profile.
bgp_community_tag string   Indicates the BGP tag information for layer 3 connections. It is not applicable to layer 2 connections.
req_buyer_ip_prefixes string   Indicates the IP details for layer 3 connections. It is not applicable to layer 2 connections.
ipsec_nat_traversal_support string   Indicates the Nat details for layer 3 connections.  It is not applicable to layer 2 connections.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

GET V2 Seller Services {profile_name}

Note: This API has been deprecated and replaced by GET /ecx/v3/l2/serviceprofiles/services/{uuid}. Refer to GET L2 service profiles services {uuid} under the API Reference section for more information.

 

GET v2/sellerservices/{profile_name}

 Method  GET
 URL or End Point  /ecx/v2/sellerservices/{profile_name}
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  Not applicable

 

The services API returns the layer 2 service profile details for a given profile name. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshots show a sample curl request and JSON response to obtain the seller details for the profile John-Doe. 

 

curl -X

GET "https://api.equinix.com/ecx/v2/sellerservices/John-Doe"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

The description of the URL parameter is as follows:

 

URL Parameter Name Mandatory Type Example Applicable Values Description
profile_name Yes string John-Doe

 

Name of the service profile.
 

 

{
  "seller_services": [
    {
      "name": "John-Doe",
      "metros": [
        {
          "availability_status": "In Trail testing",
          "code": "HK",
          "ibxs": [
            "HK2"
          ],
          "name": "Hong Kong"
        }
        ],
      "allow_custom_speed": "N",
      "standard_speeds": [
        "Up to 1G",
        "Up to 2G",
        "Up to 5G",
        "Up to 10G"
      ],
      "require_redundancy": "N",
      "encapsulation": "Dot1q",
      "service_summary": "You must have AWS Account ID to create Layer 2 connection to Amazon - AWS Direct Connect - High Capacity",
      "service_type": "Layer 2 Cloud Service Connectivity",
      "bgp_community_tag": "",
      "req_buyer_ip_prefixes": "",
      "ipsec_nat_traversal_support": ""
    }
  ]
}

 

The description of the response payload is as follows:

 

Field Name  Type Example Description
seller_services array[object]   An array containing service profile information.
name string John-Doe The name assigned to the service profile.
metros array[object]   An array containing the metro details associated with this profile where connections can be created.
availability_status string

In Trail testing

Indicates whether or not redundant connections are required when connecting to this service profile.
code string

HK

The metro code denoting metros where connections to this service profile can be created.
ibxs array[string] HK2 Equinix IBX code associated with this metro.
name string

Hong Kong

Name of the location associated with the IBX and metro.
allow_custom_speed string N Indicates whether or not to allow custom bandwidths/speeds to be defined when creating connections to this profile.
standard_speeds array[string] Up to 1G An array containing the speeds/bandwidth ranges allowed when creating connections to this profile.
require_redunancy string N Indicates whether the seller service profile requires a redundant connection to be created.
encapsulation string Dot1q The port encapsulation type for this profile. It can either be Dot1q or Qinq.
service_summary string You must have AWS Account ID to create Layer 2 connection to Amazon - AWS Direct Connect - High Capacity Provides a summary or any additional information about the seller service profile.
service_type string Layer 2 Cloud Service Connectivity Indicates the service type supported by this service profile.
bgp_community_tag string   Indicates the BGP tag information for layer 3 connections. It is not applicable to layer 2 connections
req_buyer_ip_prefixes string   Provides the IP details for layer 3 connections. It is not applicable to layer 2 connections.
ipsec_nat_traversal_support string   Indicates the Nat details for layer 3 connections.  It is not applicable to layer 2 connections.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

POST Connection

Note: This API has been deprecated and replaced by POST /ecx/v3/l2/connections. Refer to the connectivity use cases under How-to Guide section for more information

 

POST /v2/connections

 Method  POST
 URL or End Point  /ecx/v2/connections
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body Parameters  metro_code, service_type, seller_service, primary_name,   primary_port_name, primary_vlan_id, aws_account,   primary_speed

 

The POST connections API creates a Layer 2 Connection between your port and the destination service profile. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens section under Getting Started.

 

The following screenshots show a sample curl request to create a layer 2 AWS and Azure connection using a Dot1q and QinQ port, and a sample JSON response for this API. 

 

AWS connection using a Dot1q port

 

curl -X

POST "https://api.equinix.com/ecx/v2/connections"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{
  "metro_code": "SV",
  "service_type": "Layer 2 Cloud Service Connectivity",
  "seller_service_name":"AWS Direct Connect - High Capacity",
  "primary_name": "AWS_Demo",
  "primary_port_name": "EQIX-EMERGING-SERVICES-SV4-CX-PRI-03",
  "primary_vlan_id": "450",
  "aws_account": "905272066882",
  "primary_speed":"1 GB"
}'

 

AWS connection using a QinQ port

 

curl -X

POST "https://api.equinix.com/ecx/v3/l2/connections"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{
  "metro_code": "SV",
  "service_type": "Layer 2 Cloud Service Connectivity",
  "seller_service_name":"AWS Direct Connect",
  "primary_name": "AWS_Demo",
  "primary_port_name": "JOHN-BUYER",
  "primary_vlan_id": "450.451",
  "aws_account": "123456789012",
  "primary_speed":"50 MB"
}'

 

Azure Express route connection using a Dot1q port

 

curl -X

POST "https://api.equinix.com/ecx/v3/l2/connections"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{

 "metro_code": "SV",
 "service_type": "Layer 2 Cloud Service Connectivity",
 "seller_service_name":"Azure Express Route",
 "redundancy_type":"Dual Home",
 "primary_name": "Azure_Demo_Primary_V2",
 "primary_port_name": "JOHN-BUYER-PRIMARY",
 "secondary_name": "Azure_Demo_Secondary_V2",
 "secondary_port_name": "JOHN-BUYER-SECONDARY",
 "primary_vlan_id": "450",
 "secondary_vlan_id": "451",
 "named_tag": "Public",
 "service_key": "c3c453-6fb0-4b1a-b6ae-83345487",
"primary_speed":"50 MB"

}

 

 

The description of the body parameters is as follows:

 

Body Parameter Name Mandatory Type Example Applicable Values Description
metro_code Yes string SV   The metro in which the connection will be created. 
service_type Yes string Layer 2 Cloud Service Connectivity

Layer 2 Cloud Service Connectivity

Layer 3 Cloud Service Connectivity

The service type of connection.
seller_service_name Yes string AWS Direct Connect   Name of the provider's service profile.
redundancy_type Yes string  

Single Home

Dual Home 

No Redundancy 

The type of redundancy associated with connection request.
primary_name Yes string AWS_Demo   Name of the primary connection - An alpha-numeric 24 characters string which can include only hyphens and underscores ('-' & '_').
primary_port_name Yes string JOHN-BUYER-PRIMARY   Name of the buyer's primary port from which the connection would originate.
secondary_name Yes string Azure_Demo_Secondary_V2   Name of the secondary connection.
secondary_port_name Yes string JOHN-BUYER-SECONDARY   Name of the buyer's secondary port from which the connection would originate.
primary_vlan_id Yes string 450.451

 

S-Tag/Outer-Tag and C-Tag/Inner-Tag  of the primary connection.  If the seller service profile requires both outer and inner tag, the value should follow the format: ‘outer-tag.inner-tag’.

secondary_vlan_id Yes string 451

 

S-Tag/Outer-Tag and C-Tag/Inner-Tag  of the secondary connection.  If the seller service profile requires both outer and inner tag, the value should follow the format: ‘outer-tag.inner-tag’.
named_tag Yes string Public

"Private" 

"Public" 

"Microsoft" 

"Manual"

The type of peering you would like to set up with Azure Express Route.
aws_account Yes string 123456789012   Authorization Key obtained from the provider. For example, Account ID from AWS.
service_key   string c3c453-6fb0-4b1a-b6ae-83345487   Authorization Key obtained from the provider. Example: Service Key from Azure Express Route.
primary_speed Yes integer 50 MB   Speed/Bandwidth you would like to allocate to the connection.

 

The following table indicates the tagging criteria to be followed when a buyer/customer (A-side) wants to connect to AWS (Z-side). Ensure to add the correct S tag or C tag based on your port type.

 

Port Type (A-side) S-tag required C-tag required Port Type ( Z-side)
Dot1q port Yes No Dot1q port
QinQ port Yes Yes Dot1q port

 

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

 

{
    "message": "Your Connection request is successful.",
    "result": "SUCCESS",
    "more_info": "",
    "primary_connection_id": "055bbb6b-b36b-4568-b72b-8a225b01fe12",

    "secondary_connection_id": "cc6c4783-5308-421b-b2ac-149e4e204907"
}

 

The description of the response payload is as follows:

 

Field Name Type Example Description
message string Your Connection request is successful A descriptive status of the API call.
result string SUCCESS Indicates the status of the API call.
more_info string   Indicates any additional information related to the API call.
primaryConnectionID string 9999a8-0e07-44d0-944c-88a25d8d28f7 Indicates the primary connection ID  of the connection that was created.
secondary_connection_id string cc6c4783-5308-421b-b2ac-149e4e204907 Indicates the secondary connection ID  of the connection that was created.

 

Once the POST Connections API is successfully called, you may check the status of the connection using the API /ecx/v2/connections/{connection_id}

PATCH connection {connection_id}

Note: This API has been deprecated and replaced by PATCH /ecx/v3/l2/connections/{connId}. Refer to step 3 under Connect to AWS section for more information.

 

PATCH v2/hostedconnection/connection/{connection_id}

 Method  PATCH
 URL or End Point  /ecx/v2/hostedconnection/connection/{connection_id}
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body Parameters  Connection type, AWS Access Keys (Access ID and Secret Key)

 

Connection_id is an identifier unique for each connection.

 

The PATCH connections API is used for accepting a given connection.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshots show a sample curl request to accept a layer 2 connection and its respective JSON response. 

 

curl -X

PATCH "https://api.equinix.com/ecx/v2/hostedconnection/connection/9999a8-0e07-44d0-944c-88a25d8d28f7"

-H "content-type: application/json"

-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{

"connection_type":"single",

"access_id":"AKIAGGJKJU7BC3QJKYQ",

"secret_key":"CXGJW1lWbqENEqSkBAK"

}'

 

The description of the query and request payload is as follows:

 

Body Parameter Name Mandatory Type Example Description
connection_type        
access_id Yes string AKIAGGJKJU7BC3QJKYQ Special keys provided by AWS to authenticate API requests.
secret_key Yes string CXGJW1lWbqENEqSkBAK Special keys provided by AWS to authenticate API requests.

 

{
    "message": "Connection enabling request successful",
    "result": "SUCCESS",
    "more_info": ""
}

 

The description of the response payload is as follows:

 

Field Name Type Example Description
message string Connection enabling request successful  A descriptive status of the API call.
result string SUCCESS Indicates the status of the PATCH API call.
more_info string   Indicates any additional information related to the API call.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

GET Connections

Note: This API has been deprecated and replaced by GET /ecx/v3/l2/buyer/connections. Refer to GET L2 buyer connections under the API Reference section for more information.

 

GET v2/connections

 Method  GET
 URL or End Point  /ecx/v2/connections
 Headers  Authorization, Content-Type
 Query Parameters  metro_code, seller_port_name, state, pending, metadata, search_type
 Body  Not applicable

 

This API returns all outgoing connections of the user. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshots show a sample curl request to obtain all outgoing L2 connections for user credentials submitted and its JSON response. 

 

curl -X

GET "https://api.equinix.com/ecx/v2/connections?metroCode=DC"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

The description of the query parameters are as follows:

 

Query Parameter Name Mandatory Type Example Applicable Values Description
metro_code No string DC

 

The 2 character code denoting the metro to which connections have been created. It can be a single code (&metroCode=Dc) or an array of codes (&metroCode=Dc&metroCode=Sv). 
seller_port_name No string JohnDoePort   The name of the seller port.
state No string PROVISIONED

"PROVISIONED"

"DEPROVISIONED"

"PENDING_APPROVAL"

Indicates the status of the connection at Equinix's end (A Side).
pending No string  

"add"

"delete"

Status of the connections. This is a mandatory parameter for Seller. Possible values are

add - To get all the connections that are created by a buyer but not yet accepted by the seller
delete - To get all the connections that are deleted by a buyer but not yet accepted the deletion by the seller

metadata No string     Metadata.
search_type No string AND

"AND"

"OR"

Filter criteria for metadata.

 

{
  "connections": [
    {
      "id": "3a4ca7d6-3f03-4928-85cd-44f442eae046",
      "name": "John_Demo_Connection",
      "connection_type": "Layer 2 Cloud Service Connectivity",
      "buyer_port_name": "JD-SV4-PRI-03",
      "seller_service_name": "AWS Direct Connect - High Capacity",
      "service_key": "1234566882",
      "aws_account": "1234566882",
      "digital_authorization_key": "1234566882",
      "buyer_vlan_id": "790",
      "speed": "Up to 1G",
      "state": "Provisioned",
      "status": "Enabled",
      "created_date": "02/20/2020 03:43:10",
      "created_by": "John Doe",
      "notification_contacts": [
        "johnDoe@equinix.com"
      ],
      "seller_port_name": "jd-fg2l33c",
      "seller_vlan_id": "710",
      "metro_code": "SV",
      "metro_name": "Silicon Valley",
      "ibx_name": "SV1",
      "redundant_id": "",
      "instance_id": "",
      "instance_speed": "",
      "billing_tier": "Up to 1G",
      "equinix_bgp_asn": "",
      "equinix_peer_ip": "",
      "buyer_bgp_asn": "",
      "buyer_peer_ip": "",
      "bgp_authentication_key": "",
      "named_tag": null,
      "purchase_order_no": "1234",
      "buyer_public_prefixes": "",
      "metadata": []
    }
  ]
}

 

The description of the response payload is as follows:

 

Field Type Example Description
connections array    
id string 3a4ca7d6-3f03-4928-85cd-44f442eae046 The unique identifier of the connection.
name string John_Demo_Connection Name of the connection.
connection_type string Layer 2 Cloud Service Connectivity Indicates the type of connection.
buyer_port_name string JD-SV4-PRI-03 The name of the port from which the connection is established. (i.e. A-side port name)
seller_service_name string AWS Direct Connect - High Capacity The name of the seller profile associated with the connection.
service_key string 1234566882 The AWS key used by the user/customer for this connection.
aws_account string 1234566882 The AWS account used by the user/customer for this connection.
digital_authorization_key string 1234566882 The authorization key used by the user/customer when creating connections to seller profiles.
buyer_vlan_id string 450 The Stag of the connection.
speed string Up to 1G Bandwidth speed
state string Provisioned The status of the connection at Equinix's end.
status string Enabled  
created_date string 02/20/2020 03:00:40 The date on which the connection was created.
created_by string John Doe The username of the user who created the connection.
notification_contacts string null The email address of the contact to be notified during any updates on the connection.
seller_port_name string jd-fg2l33c Z-side port name.
seller_vlan_id string 710 The S Tag of the Z side port.
metro_code string SV The metro code denoting the source metro from where the connection was created. 
metro_name string

Silicon Valley

The name of the source metro from where the connection was created. 
ibx_name string SV4 Name of the Equinix IBX associated with this metro.
redundant_id string   The unique ID that groups a primary and secondary connection.
instance_id string

 

Provides the instance ID. It is not applicable to layer 2 connections.
instance_speed string   Indicates the instance speed. It is not applicable to layer 2 connections.
billing_tier string Up to 1G Billing tier for connection.
equinix_bgp_asn string

 

Indicates the Equinix BGP ASN information for layer 3 connections. It is not applicable to layer 2 connections.
equinix_peer_ip string  

 

Provides the peering details for layer 3 connections. It is not applicable to layer 2 connections.
buyer_bgp_asn string

 

Indicates the Buyer BGP ASN information for layer 3 connections. It is not applicable to layer 2 connections.
buyer_peer_ip string   Provides the peering IP details for layer 3 connections. It is not applicable to layer 2 connections.
bgp_authentication_key string   Indicates the BPG authentication details for layer 3 connections. It is not applicable to layer 2 connections.
named_tag string   The type of peering for Azure Express Route.
purchase_order_no string 1234 An optional field to link the purchase order numbers to the connection on Equinix which would get reflected on the invoice.
buyer_public_prefixes string   Indicates the IP details for layer 3 connections. It is not applicable to layer 2 connections.
metadata array[string]   An array of data providing information about other data.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

GET Connections {connection_id}

Note: This API has been deprecated and replaced by GET /ecx/v3/l2/connections/{uuid}. Refer to GET L2 connections {uuid} under the API Reference section for more information.

 

GET v2/connections/{connection_id}

 Method  GET
 URL or End Point  /ecx/v2/connections/{connection_id}
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  Not applicable

 

The connections API returns connection details for a given layer 2 connection ID. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

Connection ID is an identifier unique for each connection.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshots show a sample curl request to obtain L2 connection details for the ID 97d1850f-4df0-468c-9281-fa7b0dfa2096 and a JSON response containing connection information. 

 

curl -X

GET "https://api.equinix.com/ecx/v2/connections/006d08e2-788e-4c83-82d3-07b1787644a5"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

The description of the URL parameter is as follows:

 

URL Parameter Name Mandatory Type Example Applicable Values Description
uuid Yes string 006d08e2-788e-4c83-82d3-07b1787644a5

 

Identifier of connection.
 

 

{
  "connections": [
    {
      "id": "c58484c1-e274-4b3a-b8ad-c7c9415e2d42",
      "name": "John_Demo_Connection",
      "connection_type": "Layer 2 Cloud Service Connectivity",
      "buyer_port_name": "JD-SV4-PRI-03",
      "seller_service_name": "AWS Direct Connect - High Capacity",
      "service_key": "1234566882",
      "aws_account": "1234566882",
      "digital_authorization_key": "1234566882",
      "buyer_vlan_id": "450",
      "speed": "Up to 1G",
      "state": "Provisioned",
      "status": "Enabled",
      "created_date": "02/20/2020 03:00:40",
      "created_by": "John Doe",
      "notification_contacts": null,
      "seller_port_name": "jd-fg2l33c",
      "seller_vlan_id": "710",
      "metro_code": "SV",
      "metro_name": "Silicon Valley",
      "ibx_name": "SV4",
      "redundant_id": "",
      "instance_id": "",
      "instance_speed": "",
      "billing_tier": "Up to 1G",
      "equinix_bgp_asn": "",
      "equinix_peer_ip": "",
      "buyer_bgp_asn": "",
      "buyer_peer_ip": "",
      "bgp_authentication_key": "",
      "named_tag": null,
      "purchase_order_no": "",
      "buyer_public_prefixes": "",
      "metadata": []
    }
  ]
}

 

The description of the response payload is as follows:

 

Field Type Example Description
connections array    
id string c58484c1-e274-4b3a-b8ad-c7c9415e2d42 The unique identifier of the connection.
name string John_Demo_Connection Name of the connection.
connection_type string Layer 2 Cloud Service Connectivity Indicates the type of connection.
buyer_port_name string JD-SV4-PRI-03 The name of the port from which the connection is established. (i.e. A-side port name)
seller_service_name string AWS Direct Connect - High Capacity The name of the seller profile associated with the connection.
service_key string 1234566882 The AWS key used by the user/customer for this connection.
aws_account string 1234566882 The AWS account used by the user/customer for this connection.
digital_authorization_key string 1234566882 The authorization key used by the user/customer when creating connections to seller profiles.
buyer_vlan_id string 450 The Stag of the connection.
speed string Up to 1G Bandwidth speed
state string Provisioned The status of the connection at Equinix's end.
status string Enabled  
created_date string 02/20/2020 03:00:40 The date on which the connection was created.
created_by string John Doe The username of the user who created the connection.
notification_contacts string null The email address of the contact to be notified during any updates on the connection.
seller_port_name string jd-fg2l33c Z-side port name.
seller_vlan_id string 710 The S Tag of the Z side port.
metro_code string SV The metro code denoting the source metro from where the connection was created. 
metro_name string

Silicon Valley

The name of the source metro from where the connection was created. 
ibx_name string SV4 Name of the Equinix IBX associated with this metro.
redundant_id string   The unique ID that groups a primary and secondary connection.
instance_id string

 

Provides the instance ID for layer 3 connections. It is not applicable to layer 2 connections.
instance_speed string   The instance speed for layer 3 connections. It is not applicable to layer 2 connections.
billing_tier string Up to 1G Billing tier for connection.
equinix_bgp_asn string

 

Indicates the Equinix BGP ASN information for layer 3 connections. It is not applicable to layer 2 connections
equinix_peer_ip string

 

Provides the peering details for layer 3 connections. It is not applicable to layer 2 connections.
buyer_bgp_asn string

 

Indicates the Buyer BGP ASN information for layer 3 connections. It is not applicable to layer 2 connections.
buyer_peer_ip string   Provides the peering IP details for layer 3 connections. It is not applicable to layer 2 connections.
bgp_authentication_key string   Indicates the BPG authentication details for layer 3 connections. It is not applicable to layer 2 connections
named_tag string   The type of peering for Azure Express Route.
purchase_order_no string   An optional field to link the purchase order numbers to the connection on Equinix which would get reflected on the invoice.
buyer_public_prefixes string   Indicates the IP details for layer 3 connections. It is not applicable to layer 2 connections.
metadata array[string]   An array of data providing information about other data.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

DELETE Connections {connection_id}

Note: This API has been deprecated and replaced by DELETE /ecx/v3/l2/connections/{uuid}. Refer to DELETE L2 connections {uuid}under the API Reference section for more information.

 

DELETE /connections/{connection_id}

 Method  DELETE
 URL or End Point

 /ecx/v2/connections/{connection_id}

 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  Not applicable

 

This API deletes the connection of a given connection ID. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

Connection_id is an identifier unique for each connection.

 

If the connection is connected to a seller service provider other than Azure or AWS, the respective seller service provider must acknowledge this delete request for the connection to be deleted.

 

If you are unaware of how to obtain an authorization key, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshots show a sample curl request and JSON response to delete a connection with connection_id 702d31c4-c66d-49b0-a26c-a9a234e56fsb 

 

curl -X

DELETE "https://api.equinix.com/ecx/v2/connections/702d31c4-c66d-49b0-a26c-a9a234e56fsb"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

{
    "message": "Your connection has been deleted successfully.",
    "result": "SUCCESS",
    "more_info": null
}

 

The description of the response payload is as follows:

 

Field Name Type Example values Description
message string Your connection has been deleted successfully. A descriptive status of the API call.
result string SUCCESS Indicates the status of the API call.
 
more_info string null Indicates any additional information related to the API call.

 

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Cloud Exchange Fabric Portal access.

 

Once the API is successfully called, you may verify the status of the connection using the API /ecx/v2/connections/{connection_id}