Connect Using Two Service Tokens

Establish a connection between your A-side and Z-side service tokens. On the Z-side, you can have Colo, Network Edge, or Network service token.

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 Token Information

1. List available service tokens

Call Get All Service Tokens to get all available service tokens.

Step 3: Create Connection

Use POST /fabric/v4/connections API request to create a connection.

A service token can be dispatched to a number of recipients, and it's valid for a single use by any of them.

POST /fabric/v4/connections
Method POST
Endpoint /fabric/v4/connections
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters type, name, order, redundancy, bandwidth, aSide, zSide, notifications

Call Retrieve Pricing to get connection price estimate.


Sample curl request - connection from an A-side to a Z-side service token

Copy 
curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "EVPL_VC",
    "name": "AST_TO_ZST_CONNECTION",
    "order": {
    "purchaseOrderNumber": "1-129105284100"  },
    "bandwidth": 100,
    "redundancy": {
    "priority": "PRIMARY"  },
    "aSide": {
    "serviceToken": {
        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"    }
    },
    "zSide": {
    "serviceToken": {
        "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"    }
    },
    "notifications": [
    {
        "type": "ALL",
        "emails": [
        "test@equinix.com",
        "test1@equinix.com"      ]
    }
    ]
}'

Body parameters

Parameter Mandatory Type Example values Applicable values Description
type Yes string EVPL_VC

  • EVPL_VC

  • EVPLAN_VC

  • EPLAN_VC

Connection type.
EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections.

EVPLAN_VC

EPLAN_VC
name Yes string Conn-1 Maximum: 24 characters
Allowed characters: alpha-numeric, hyphens ('-') and underscores ('_') 		Connection name.
order No object - - Order details.
order.purchaseOrderNumber No string 1-129105284100 - Subscriber's purchase order identifier.
bandwidth Yes integer 1000

Use the Get Specified Service Token API to retrieve details on available connection speeds.

Connection bandwidth in Mbps.
aSide Yes object - - Source port definition.
aSide.serviceToken Yes object - - Authorization token created by the provider (A-side) to create a connection.
serviceToken.uuid Yes object 20d32a80-0d61-4333-bc03-707b591ae2f4 - Service token identifier.
zSide Yes object - - Destination port definition.
zSide.serviceToken Yes object - - Authorization token created by the provider (Z-side) to create a connection. You can have Colo, Network Edge, or Network service token.
serviceToken.uuid Yes object 20d32a80-0d61-4333-bc03-707b591ae2f4 - Service token identifier.
notifications yes array[object] - - Subscriber preferences for notification of changes in asset configuration or status.
notifications.type yes string ALL ALL Notification preferences for a specified asset, such as a service token, port, access point, or profile.
notifications.emails yes array[string] ["john@equinix.com", "jenkins@equinix.com"] Minimum: 1
Maximum: 12		 List of up to 12 recipients.
redundancy Conditional object - - Redundancy details. This object is not mandatory for primary connections. However, you must provide the redundancy details for secondary connections.
redundancy.group Conditional string m167f685-41b0-1b07-6de0-320a5c00abeu - Unique Id of the redundancy group. This is only required for secondary connections. If you are creating a secondary connection, enter the group of the PRIMARY. You can find the group of the primary connection by calling Get Specified Connection or by checking the "group" field in the response you receive when creating primary connection.
redundancy.priority Conditional string PRIMARY PRIMARY
SECONDARY		 Whether the connection is PRIMARY or SECONDARY. Don't provide a redundancy group for a PRIMARY connection.

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


Sample response - A-side service token to Z-side Port service token

Copy 
{
    "href": "http://api.equinix.com/fabric/v4/connections/b067f685-49b0-1a09-6fe0-360a5d00a",
    "type": "EVPL_VC",
    "uuid": "b067f685-49b0-1a09-6fe0-360a5d00a",
    "name": "AST_TO_ZST_CONNECTION",
    "state": "ACTIVE",
    "operation": {
        "providerStatus": "PROVISIONED",
        "equinixStatus": "PROVISIONED"    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com"            ]
        }
    ],
    "account": {
        "accountNumber": 201246,
        "orgId": 92610,
        "globalOrgId": "0017i000011X250AAC"    },
    "changeLog": {
        "createdBy": "testuser",
        "createdDateTime": "2022-05-16T07:50:49.749Z"    },
    "bandwidth": 100,
    "redundancy": {
        "group": "b067f685-49b0-1a09-6fe0-360a5d00afdg",
        "priority": "PRIMARY"    },
    "isRemote": true,
    "direction": "OUTGOING",
    "aSide": {
        "serviceToken": {
            "href": "https://api.equinix.com/fabric/v4/serviceTokens/b067f685-49b0-1a09-6fe0-360a5d00afdg",
            "uuid": "b067f685-49b0-1a09-6fe0-360a5d00afdg"        },
        "accessPoint": {
            "location": {
                "metroHref": "http://api.equinix.com/fabric/v4/metros/SV",
                "metroCode": "SV"            },
            "port": {
                "href": "http://api.equinix.com/fabric/v4/ports/b067f685-49b0-1a09-6fe0-360a5d00afdg",
                "uuid": "b067f685-49b0-1a09-6fe0-360a5d00afdg"            },
            "linkProtocol": {
                "type": "DOT1Q"            }
        }
    },
    "zSide": {
        "serviceToken": {
            "href": "https://api.equinix.com/fabric/v4/serviceTokens/b067f685-49b0-1a09-6fe0-360a5d00afdg",
            "uuid": "b067f685-49b0-1a09-6fe0-360a5d00afdg"        },
        "accessPoint": {
            "location": {
                "metroHref": "http://api.equinix.com/fabric/v4/metros/SV",
                "metroCode": "SV"            },
            "port": {
                "href": "http://api.equinix.com/fabric/v4/ports/b067f685-49b0-1a09-6fe0-360a5d00afdg",
                "uuid": "b067f685-49b0-1a09-6fe0-360a5d00afdg"            },
            "linkProtocol": {
                "type": "DOT1Q"            }
        }
    },
    "order": {
        "purchaseOrderNumber": "1122334",
        "billingTier": "Up to 50 MB"    }
}

Response payload body description

Response payload includes configuration parameters defined in the request body. The following table contains descriptions of additional information included in the response payload. For descriptions of the remaining fields, refer to the Body parameters section.

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 Type of connection.
uuid string 3a58dd05-f46d-4b1d-a154-2e85c396ea62 Equinix-assigned connection identifier.
name string AST_TO_ZST_CONNECTION Name of the connection.
state string PROVISIONING Status of the connection.
operation object - Operation status.
operation.equinixStatus string PROVISIONING Status of the connection on Equinix's end.
operation.providerStatus string NOT_AVAILABLE Status of the connection on provider's end.
notifications array An array that has notification details.
notifications.type string ALL Type of notification.
notifications.emails array test@equinix.com, test2@equinix.com The list of emails to be notified.
account object Object containing account details of the connection owner.
account.accountNumber integer 270235 Account number of the connection owner.
account.orgId integer 92287 Org Id of the account.
account.globalOrgId string 0016u0000033Z53AAG Global org Id of the account.
order.purchaseOrderNumber string 1122334 Purchase order number.
order.billingTier string Up to 1 Gbps Billing tier of the connection bandwidth.
bandwidth integer 1000 Bandwidth of the connection in Mbps.
redundancy object Object containing redundancy details.
redundancy.group string 7a58dd05-f46d-4b1d-a154-2e85c396ea63 Unique Id of the redundancy group.
redundancy.priority string PRIMARY Whether the connection is PRIMARY or SECONDARY.
isRemote boolean true Whether the connection is remote. The connection is remote if the endpoints are in two different locations.
direction string INTERNAL Direction of the connection (from the requestor's point of view).
aSide object Object containing aSide details.
aSide.accessPoint object Object containing aSide endpoint configuration.
location object An object that has the location details of the aSide connection.
location.region string AMER Region.
location.metroName string Ashburn Metro name.
location.metroCode string DC Metro code.
port object An object that has the aSide port details.
port.href string https://api.equinix.com/ne/v1/devices/5a58dd05-f46d-4b1d-a154-2e85c396ea63
port.uuid string 5a58dd05-f46d-4b1d-a154-2e85c396ea63 Unique Id of the port.
linkProtocol object An object that has the link protocol.
linkProtocol.type string DOT1Q Type of link protocol.
linkProtocol.vlanTag integer 10579 Vlan tag.
aSide.serviceToken object An object that has the service token details.
serviceToken.href string https://api.equinix.com/ne/v1/devices/5a58dd05-f46d-4b1d-a154-2e85c396ea63 A URL that has the service token details.
serviceToken.uuid string 5a58dd05-f46d-4b1d-a154-2e85c396ea63 Unique Id of the service token.
zSide object Object containing zSide details.
zSide.accessPoint object Object containing zSide endpoint configuration.
accessPoint.interface object Object containing details of the interface. Only relevant for Network Edge service token.
interface.uuid string 3a58dd05-f46d-4b1d-a154-2e85c396ea62 Unique identifier of the interface.
interface.id string 5 The interface id of the virtual device that hosts the connection.
interface.type string CLOUD

Type of interface.

  • CLOUD
  • NETWORK
accessPoint.location object An object that has the location details of the zSide connection.
location.metroHref string https://api.equinix.com/fabric/v4/metros/SV URL that returns the specified metro.
location.region string AMER Region.
location.metroName string Ashburn Metro name.
location.metroCode string DC Metro code.
accessPoint.virtualDevice object An object that has the virtual device details. Only relevant for Network Edge Service Token.
virtualDevice.href string https://api.equinix.com/ne/v1/devices/5a58dd05-f46d-4b1d-a154-2e85c396ea63 URL that has the specified Network Edge asset.
virtualDevice.uuid string 5a58dd05-f46d-4b1d-a154-2e85c396ea63 Unique Id of the virtual device.
virtualDevice.type string EDGE Type of virtual device.
zSide.serviceToken object An object that has the service token details.
serviceToken.href string https://api.equinix.com/fabric/v4/serviceTokens/20d32a80-0d61-4333-bc03-707b591ae2f5 An absolute URL that returns the specified service token.
serviceToken.uuid string 25acdea5-1eeb-4f0b-8ca9-6c505f46847d

Unique Id of the service token.
accessPoint.network object Object containing network configuration. Only relevant for Network service token.
network.href string http://api.equinix.com/fabric/v4/networks/7c4f2315-839b-4fbd-90ea-59adf165312d An absolute URL that returns the network asset.
network.uuid string 3a58dd05-f46d-4b1d-a154-2e85c396ea62 Equinix-assigned network identifier.
network.name string EVPLAN_NETWORK Name of the network.
network.state string ACTIVE Status of the network.
network.type string EVPLAN Type of network.
network.scope string REGIONAL Scope of network. LOCAL, REGIONAL, or GLOBAL
accessPoint.port object An object that has the zSide port details. Only relevant for Colo service token.
port.href string https://api.equinix.com/ne/v1/devices/5a58dd05-f46d-4b1d-a154-2e85c396ea63
port.uuid string 5a58dd05-f46d-4b1d-a154-2e85c396ea63 Unique Id of the port.
accessPoint.linkProtocol object An object that has the link protocol. Only relevant for Colo Service Token.
linkProtocol.type string DOT1Q Type of link protocol.
linkProtocol.vlanTag integer 10579 Vlan tag.

Call Get Specified Connection to monitor your connection status.