Skip to main content

Approve Connection - Parameters Mapping

This API request approves pending connection.

v3 request
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"
}'
v4 request
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
                }
            }
        }
    }
}'

v3 API requestv4 API requestDescription
PATCH /ecx/v3/l2/connectionsPOST /fabric/v4/connections/{uuid}/actionsRequest: v3 and v4 APIs use different methods and endpoints to approve/reject pending connections.

Response: v4 API returns the entire connection object in the response while the v3 API returns a status message.

Response

v3 request
{
    "message": "Successfully Approved",
    "primaryConnectionId": "9b1da3b0-ea1d-4770-ae51-c794ffb23dbc"
}
v4 request
{
    "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",
    "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": {
        "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",
    }
}

 

For v4 response payload description, refer to Get Specified Connection - Parameters Mapping.