Establish BGP Peering

A BGP session establishes a point-to-point connection between your virtual device and your cloud service provider. To create BGP peers, you must have the following information:

• A provisioned virtual device with a registered license.
• A provisioned connection (connectionUuid).

If you have the above information, then you can skip ahead to Create BGP Peering and create BGP peers.

Otherwise, follow the steps.

Prerequisites

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.

Get Virtual Devices

To check the status of your virtual device, call the Get Virtual Device {uuid} API or the Get VirtualDevices API.

You may skip the above step if you have a provisioned device with a registered license.

Create/Get connection

To check the status of your connections, call the Get Specified Connection {uuid} API.

You may skip this step if you have a provisioned connection.

Create BGP Peering

	POST /ne/v1/bgp
Method	POST
URL or End Point	/ne/v1/bgp
Headers	Authorization token, Content-Type
Query Parameters	Not applicable
Body Parameters	authenticationKey, connectionUuid, localAsn, localIpAddress, remoteAsn, remoteIpAddress

This request creates a BGP session to establish a point-to-point connection between your virtual device and cloud service provider.

A sample curl request to create BGP peering:

curl -X  
POST "https://api.equinix.com/ne/v1/bgp"  
-H "Authorization: Bearer <token>"  
-H "Content-Type: application/json"  
-d '{  
  "authenticationKey": "testkey1",  
  "connectionUuid": "80afc8be-0ce3-4950-be27-3d3e678e6873",  
  "localAsn": 10012,  
  "localIpAddress": "10.0.0.1/29",  
  "remoteAsn": 10013,  
  "remoteIpAddress": "10.0.0.2"  
}'

For a complete list of parameters and options, see the API Reference.

Sample Response

{  
    "uuid": "64e46bc1-fc2c-43b8-956e-213afe8f5d39"  
}

Response description:

Field	Type	Example Values	Description
uuid	string		Unique Id of the BGP peering.

BGP Status

After you create BGP peering, you can check the status of your BGP peering by calling GET BGP {uuid}.

BGP provisioningStatus	Description
PROVISIONING	BGP peering is provisioning.
PROVISIONED	BGP peering is provisioned.
FAILED	BGP peering failed.

Possible BGP states: Idle, Connect, Active, Established, OpenSent, and OpenConfirm.

The BGP states can be only be seen after the BGP is provisioned.

If you get “Access Denied,” please contact your local Equinix Service Desk.