Skip to main content

Migrate Connection to a Different Port

Migrate connection to a different A-side port.

Prerequisites

  1. Authenticate - Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication. Refer to API Authentication for instructions on how to call the OAuth API to validate and authenticate your credentials.

  2. Determine the existing connection ID. Use the Search Connections endpoint to retrieve a list of connections and determine the ID of the connection that you want to migrate to a different port.

  3. Get the port information using the Get All Ports endpoint for the ID of the port that you want to migrate your connection to.

Updating the Connection

To update a connection and migrate it to a different port, send a PATCH request to the /fabric/v4/connections/{id} endpoint. Specify the connection's a-side port ID to the port you are migrating the connection to in the body of the request.

PATCH /fabric/v4/connections/{uuid}
MethodPATCH
URL or Endpoint/fabric/v4/connections/{uuid}
HeadersAuthorization, Content-Type
Path Parametersuuid
Query ParametersNot applicable
Body Parametersop, path, value

Sample cURL Request:

curl -X  
PATCH 'https://api.equinix.com/fabric/v4/connections/{connection_id}'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-d '[
    {
        "op": "replace",
        "path": "/aSide/accessPoint/port/uuid",
        "value": "c791f8cb-599a-99a0-8ce0-306a5c00a4ee"
    }
]'

Path parameters

ParameterMandatoryTypeExampleApplicable ValuesDescription
uuidyesstring3a58dd05-f46d-4b1d-a154-2e85c396ea62-Equinix-assigned connection identifier.

Body parameters

ParameterMandatoryTypeExampleApplicable ValuesDescription
opyesstringreplacereplaceUpdate reqest type.
pathyesstring/aSide/accessPoint/port/uuid/aSide/accessPoint/port/uuidParameter path.
valueyesstringc791f8cb-599a-99a0-8ce0-306a5c00a4ee-Parameter value.
/aSide/accessPoint/port/uuid
valueyesstringc791f8cb-599a-99a0-8ce0-306a5c00a4ee-Eqinix-assigned port identifier.

Sample Response:

{  
    "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,
    "redundancy": {
        "group": "m167f685-41b0-1b07-6de0-320a5c00abeu",
        "priority": "PRIMARY"
    },
    "aSide": {
        "accessPoint": {
            "type": "COLO",
            "port": {
                "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-599a-99a0-8ce0-306a5c00a4ee",
                "type": "XF_PORT",
                "uuid": "c791f8cb-599a-99a0-8ce0-306a5c00a4ee"
            },
            "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",
    }
}