Skip to main content
Index

Approve or Reject Connection

Step 1: Authenticate

Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.

 

Refer to Generating a Client ID and Client Secret key under Getting Started section for instructions on how to create client ID and client secret and refer to Requesting Access and Refresh tokens for instructions on how to call OAuth API to validate and authenticate your credentials.

 

If you are unaware of your user credentials for Equinix Fabric, contact your local Equinix Service Desk. 

Step 2: Retrieve Connections and Identify ports

2a) Retrieve connections

Identify the incoming connection you wish to accept or reject.

 

Refer to GET Seller Connections under the API Reference section for instructions on how to get all the seller connections. You may skip this step if you already know the connection details.  

 

2b) Identify ports

Identify your Equinix Fabric port(s) you intend to assign to the incoming connection.

 

Refer to GET Port under the API Reference section for instructions on how to retrieve your port details. You may skip this step if you already know the available port information.

Step 3: Accept or Reject Connection

Accept or reject incoming virtual connections to seller profile using the below API.

 

PATCH /ecx/v3/l2/connections

 Method  PATCH
 URL or End Point  /ecx/v3/l2/connections/{connId}
 Headers  Authorization, Content-Type
 Query Parameters  action
 Body Parameters  primaryPortUUID, primaryVlanSTag, primaryVlanCTag, secondaryPortUUID, secondaryVlanSTag,     secondaryVlanCTag, rejectComment

 

 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.

 

connID is an identifier unique for each connection. The connection ID would be represented as uuid in the response of the seller connections API. 

 

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 accept a layer 2 connection request and a sample JSON response for this API. 

 

curl -X

PATCH "http://api.equinix.com/ecx/v3/l2/connections/9b1da3b0-ea1d-4770-ae51-c794ffb23dbc?action=Approve

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{

  "primaryPortUUID": "754086e4-164d-64d0-84e0-30ac188c7c35",
  "primaryVlanSTag": "555"

}'

 

{
    "message": "Successfully Approved",
    "primaryConnectionId": "9b1da3b0-ea1d-4770-ae51-c794ffb23dbc"
}

 

curl -X

PATCH "http://api.equinix.com/ecx/v3/l2/connections/60bfd673-8fbc-4de9-be4b-176ad8f3e908?action=Reject

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{

  "rejectComment": "JohnDoe rejected"

}'

 

{
    "message": "Action successfully performed",
    "primaryConnectionId": "60bfd673-8fbc-4de9-be4b-176ad8f3e908"
}

 

curl -X

PATCH "http://api.equinix.com/ecx/v3/l2/connections/9b1da3b0-ea1d-4770-ae51-c794ffb23dbc?action=Approve

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{

  "primaryPortUUID": "7cb83fdb-6620-6204-bbe0-38389cc0acfa",

  "primaryVlanSTag": "779",

  "secondaryPortUUID": "7cb83fdb-663a-63a4-bbe0-38389cc0acfa",

  "secondaryVlanSTag": "780"

}'

 

{
    "message": "Successfully Approved",
    "moreInfo": "Redundant connection also approved",
    "primaryConnectionId": "b9fb8603-a0a0-4534-a03a-78f3c9126bb5",
    "secondaryConnectionId": "13f1b31a-855b-44ca-b30a-4322a4d3af0b"
}

 

 

The description of the body parameters is as follows:

 

Body Parameter Name Mandatory Type Example values Applicable values Description
primaryPortUUID Yes string 754086e4-164d-64d0-84e0-30ac188c7c35   The Z side port ID to which the buyer is connecting. 
primaryVlanSTag Yes string 555  

S tag information of the port.

 

Range: 2 - 4094

primaryVlanCTag Yes string 555  

C tag information of the port.

 

Range: 2 - 4094

secondaryPortUUID Yes string 7cb83fdb-6620-6204-bbe0-38389cc0acfa   The secondary Z side port ID to which the buyer is connecting. 
secondaryVlanSTag Yes string 779  

S tag information of the secondary port.

 

Range: 2 - 4094

secondaryVlanCTag Yes string 780  

C tag information of the secondary port.

 

Range: 2 - 4094

rejectComment Yes string JohnDoe rejected   Comment indicating why the connection was rejected.

 

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

 

The description of the response payload is as follows:

 

Field Name Type Example values Description
message string Connection Saved Successfully Indicates the status of the API call.
primaryConnectionID string 9999a8-0e07-44d0-944c-88a25d8d28f7 Indicates the primary connection ID.
secondaryConnectionID string 9999a8-0e07-44d0-944c-88a25d8d28f7 Indicates the secondary connection ID.