Approve or Reject Connection

Step 1: Authenticate

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

 

Refer to Generating Client ID and Client Secret under the Getting Access Token section for instructions on how to create client ID and client secret and refer to Requesting Access and Refresh tokens section 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: Get Attribute Information

1. Determine pending connection identifier
Use the Retrieve Connections API request to retrieve a list of pending connections and identify the one you want to approve/reject.

2. Determine Z-side port information
Retrieve your Equinix Fabric ports information using the Get All Ports API request

Step 3: Approve or Reject Connection

Use the POST /fabric/v4/connections/{uuid}/actions API request to create a connection with the pre-determined attributes.

	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

Sample curl request - approve connection

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

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"
}'

Path parameters

Parameter	Mandatory	Type	Example Values	Applicable Values	Description
uuid	yes	string	3a58dd05-f46d-4b1d-a154-2e85c396ea62	-	Equinix-assigned connection identifier.

Body parameters

Parameter	Mandatory	Type	Example Values	Applicable Values	Description
type	yes	string	CONNECTION_CREATION_ACCEPTANCE	CONNECTION_CREATION_ACCEPTANCE CONNECTION_CREATION_REJECTION	Connection management action. CONNECTION_CREATION_ACCEPTANCE - Approve pending connection. CONNECTION_CREATION_REJECTION - Reject pending connection.
description	no	string	Invalid connection update request.	-	Rejection reason.
data	conditional	object	-	-	Additional data related to the connection action type. Applicable to CONNECTION_CREATION_ACCEPTANCE
data
zSide	yes	object	-	-	Z-side (provider) connection configuration.
data.zSide
accessPoint	yes	object	-	-	Connection endpoint configuration.
data.zSide.accessPoint
type	yes	string	COLO	COLO	Access point type.
port	yes	object	-	-	Port associated with the connection.
linkProtocol	yes	object	-	-	Link protocol configuration.
data.zSide.accessPoint.port
uuid	yes	string	20d32a80-0d61-4333-bc03-707b591ae2f4	-	Equinix-assigned port identifier.
data.zSide.accessPoint.linkProtocol
type	yes	string	QINQ	DOT1Q QINQ	Link protocol type.
vlanTag	yes	integer	1001	Range: 2-4094	DOT1Q protocol VLAN tag.
vlanSTag	yes	integer	1002	Range: 2-4094	QINQ protocol, inner (customer) VLAN frame tag used to identify packets as they traverse trunk lines.
vlanCTag	yes	integer	1001	Range: 2-4094	QINQ protocol, outer (service) VLAN frame tag used to identify packets as they traverse trunk lines.

 

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

Sample response - approve connection

{
    "href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
    "type": "EVPL_VC",
    "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
    "state": "PROVISIONED",
    "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": {
        "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	Type	Example values	Description
href	string	https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62	An absolute URL that returns the specified connection.
type	string	EVPL_VC	Connection type. EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections.
uuid	string	3a58dd05-f46d-4b1d-a154-2e85c396ea62	Equinix-assigned connection identifier.
state	string	PROVISIONING	Lifecycle stage of a connection.
name	string	Conn-Name-2	Connection name.
order	object	-	Order details.
bandwidth	integer	1000	Connection bandwidth in Mbps.
change	object	-	Connection update details.
redundancy	object	-	Redundancy details.
aSide	object	-	Connection source definition.
zSide	object	-	Connection destination definition.
notifications	array[object]	-	Subscriber preferences for notification of changes in asset configuration or status.
operation	object	-	Connection operational data.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
order
purchaseOrderNumber	string	1-129105284100	Subscriber's purchase order identifier.
billingTier	string	Up to 1 Gbps	Billing tier for connection bandwidth.
change
type	string	CONNECTION_CREATION	Connection change action.
status	string	APPROVED	Connection change status.
createdDateTime	string	2021-07-15T19:30:29.526Z	Connection change timestamp in the IETF ISO 8601 extended date/time format:   YYYY-MM-DDTHH:MM:SS.000+0000
redundancy
group	string	m167f685-41b0-1b07-6de0-320a5c00abeu	Unique Id of the redundancy group.
priority	string	PRIMARY	Whether the connection is PRIMARY or SECONDARY.
aSide
accessPoint	object	-	Connection endpoint configuration.
aSide.accessPoint
type	string	COLO	Connection endpoint type. COLO - Colocation space in an IBX data center.
port	object	-	Port associated with the connection.
linkProtocol	object	-	Link protocol configuration.
aSide.accessPoint.port
href	string	https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd	An absolute URL that returns the specified port.
type	string	XF_PORT	Type of port. XF_PORT - Equinix Fabric port used as a Fabric connection endpoint.
uuid	string	a867f685-41b0-1b07-6de0-320a5c00abdd	Equinix-assigned port identifier.
aSide.accessPoint.linkProtocol
type	string	DOT1Q	Link protocol type.
vlanTag	integer	1001	DOT1Q protocol VLAN tag.
zSide
accessPoint	object	-	Connection endpoint configuration.
zSide.accessPoint
type	string	SP	Connection endpoint type. SP - Service profile.
profile	object	-	The service profile associated with this access point.
port	object	-	Port associated with the connection.
linkProtocol	object	-	Link protocol configuration.
location	object	-	Access point location information.
zSide.accessPoint.profile
href	string	https://api.equinix.com/fabric/v4/services/serviceProfiles/20d32a80-0d61-4333-bc03-707b591ae2f5	An absolute URL that returns the specified service profile.
type	string	L2_PROFILE	Service profile type. L2_PROFILE - layer 2 service profile for establishing connections in layer 2 of the OSI networking model.
uuid	string	20d32a80-0d61-4333-bc03-707b591ae2f5	Unique identifier assigned to the service profile associated with this access point.
zSide.accessPoint.port
href	string	https://api.equinix.com/fabric/v4/ports/c791f8cb-5ae1-ae10-8ce0-306a5c00a4ee	An absolute URL that returns the specified port.
uuid	string	c791f8cb-5ae1-ae10-8ce0-306a5c00a4ee	Equinix-assigned port identifier.
name	string	testBuyer-BL1-L-Dot1q-STD-PRI-10G-JN-730	Equinix-assigned port name.
zSide.accessPoint.linkProtocol
type	string	DOT1Q	Link protocol type.
vlanTag	integer	1000	DOT1Q protocol VLAN tag.
zSide.accessPoint.location
href	string	https://api.equinix.com/v4/metros/SV	An absolute URL that returns the specified metro.
metroCode	string	SV	Metropolitan area identifier.
region	string	AMER	Broad geographic area in which a specified Equinix asset is located.
notifications
type	string	ALL	Notification preferences for a specified asset, such as a service token, port, access point, or profile.
emails	array[string]	["test@equinix.com"]	List of recipients.
operation
equinixStatus	string	PROVISIONED	Progress towards provisioning a specified connection.
providerStatus	string	PROVISIONED	Provider's progress towards provisioning a specified connection.
changeLog
createdDateTime	string	2021-07-15T19:30:29.526Z	Connection creation timestamp in the IETF ISO 8601 extended date/time format:   YYYY-MM-DDTHH:MM:SS.000+0000
updatedDateTime	string	2021-08-15T19:30:29.526Z	Connection creation timestamp in the IETF ISO 8601 extended date/time format:   YYYY-MM-DDTHH:MM:SS.000+0000