BGP

Get BGP Peerings

	GET /ne/v1/bgp
Method	GET
URL or End Point	/ne/v1/bgp
Headers	Authorization, Content-Type
Query Parameters	virtualDeviceUuid, connectionUuid, status, accountUcmId, offset, limit
Body	Not applicable

Returns BGP configurations.

Sample curl request:

Query parameters:

Query Parameter	Mandatory	Type	Example	Applicable Values	Description
virtualDeviceUuid	No	string	7ef81cbe-01ed-4c27-8b2f-69d3a3fd4d6a		Unique Id of a virtual device.
connectionUuid	No	string	7ab1bdca-0d56-457a-bbfe-4583082c721c		Unique Id of a connection.
status	No	string	PROVISIONED	PROVISIONED, DEPROVISIONED, PROVISIONING, or FAILED	Provisioning status of a BGP peering.
accountUcmId					Unique Id of the account. A reseller querying for a customer's devices can input the customer's account information. To find out the accountUcmId of your customer's account, please check the Equinix account creation portal (ECP) or call Get Account API.
offset	No	integer	0		Specifies where to start a page. It is the starting point of the collection returned from the server.
limit	No	integer	100		Specifies the page size.

Sample response:

The description of the response payload:

Field	Type	Example Values	Description
pagination	object		An object that has pagination information.
offset	integer	0	It is the starting point of the collection returned from the server.
limit	integer	20	The page size.
total	integer	100	The total number of results.
data	list[]		An array of BGP objects.
uuid	string	6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567	Unique Id of BGP peering.
connectionUuid	string	e5f30fc6-ae9d-4fbb-8020-d61329d8fe34	Unique Id of the connection between your virtual device and another service provider.
virtualDeviceUuid	string	f61e75d2-2008-43f4-bfee-1dd17b1e1a28	Unique Id of your virtual device.
localIpAddress	string	12.0.0.1/30	Local IP Address. This is the IP address of the virtual device in CIDR format.
localAsn	string	10061	Local ASN (autonomous system number). This is the ASN of your virtual device.
remoteIpAddress	string	12.0.0.2	Remote IP address. This is the IP address of the cloud service provider.
remoteAsn	string	10013	Remote ASN (autonomous system number). This is the ASN of the cloud service provider.
authenticationKey	string	pass1233	Key-value for authentication.
state	string	Idle	State of the BGP peering. One of Idle, Connect, Active, Established, OpenSent, and OpenConfirm.
createdBy	string	nfv-sit1	The username of the user who created the BGP peering.
createdDate	string	2018-08-30T04:20:36.033Z	The date on which the BGP peering was created.
createdByFullName	string	nfv-sit1 nfv-sit1	Full name of the user who created BGP peering.
createdByEmail	string	test@equinix.com	Created by email.
lastUpdatedBy	string	nfv-sit1	Last updated by.
lastUpdatedByFullName	string	nfv-sit1 nfv-sit1	Full name of the user who updated last.
lastUpdatedDate	string	2018-08-30T04:20:36.033Z	Last update date.
lastUpdatedByEmail	string	test@equinix.com	Email of the user who updated last.
provisioningStatus	string	PROVISIONED	Provisioning status of BGP peering. One of PROVISIONING, PROVISIONED, FAILED, or DEPROVISIONED.

Get BGP Peering {uuid}

	GET /ne/v1/bgp/{uuid}
Method	GET
URL or End Point	/ne/v1/bgp/{uuid}
Headers	Authorization, Content-Type
Path Parameters	uuid
Body	Not applicable

Returns a BGP configuration by its uuid.

Sample curl request:

Path parameter:

Path Parameter Name	Mandatory	Type	Example	Applicable Values	Description
uuid	Yes	string	7ef81cbe-01ed-4c27-8b2f-69d3a3fd4d6a		Unique Id of a BGP peering.

Sample response:

The description of the response payload:

Field	Type	Example Values	Description
uuid	string	6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567	Unique Id of a BGP peering.
connectionUuid	string	e5f30fc6-ae9d-4fbb-8020-d61329d8fe34	Unique Id of the connection between your virtual device and another service provider.
virtualDeviceUuid	string	f61e75d2-2008-43f4-bfee-1dd17b1e1a28	Unique Id of your virtual device.
localIpAddress	string	12.0.0.1/30	Local IP Address. This is the IP address of the virtual device in CIDR format.
localAsn	string	10061	Local ASN (autonomous system number). This is the ASN of your virtual device.
remoteIpAddress	string	12.0.0.2	Remote IP address. This is the IP address of the cloud service provider.
remoteAsn	string	10013	Remote ASN (autonomous system number). This is the ASN of the cloud service provider.
authenticationKey	string	pass1233	Key value for authentication.
state	string	Idle	State of the BGP peering. One of Idle, Connect, Active, Established, OpenSent, and OpenConfirm.
createdBy	string	nfv-sit1	The username of the user who created the BGP peering.
createdDate	string	2018-08-30T04:20:36.033Z	The date on which the BGP peering was created.
createdByFullName	string	nfv-sit1 nfv-sit1	Full name of the user who created BGP peering.
createdByEmail	string	test@equinix.com	Created by email.
lastUpdatedBy	string	nfv-sit1	Last updated by.
lastUpdatedByFullName	string	nfv-sit1 nfv-sit1	Full name of the user who updated last.
lastUpdatedDate	string	2018-08-30T04:20:36.033Z	Last update date.
lastUpdatedByEmail	string	test@equinix.com	Email of the user who updated last.
provisioningStatus	string	PROVISIONED	Provisioning status of BGP peering. One of PROVISIONING, PROVISIONED, or FAILED.

Update BGP Peering

	PUT /ne/v1/bgp/{uuid}
Method	PUT
URL or End Point	/ne/v1/bgp/{uuid}
Headers	Authorization token, Content-Type
Path Parameter	uuid
Body Parameters	authenticationKey, localAsn, localIpAddress, remoteAsn, remoteIpAddress

Updates the BGP peering between a virtual device and a cloud service provider.

Sample curl request:

Path parameter:

Path Parameter	Mandatory	Type	Example	Possible Values	Description
uuid	Yes	string	7ab1bdca-0d56-457a-bbfe-4583082c721c		Unique Id of a BGP peering.

Body parameters:

Body Parameters	Mandatory	Type	Example	Possible Values	Description
authenticationKey	No	string	pass123		Provide a key value that you will use to authenticate later.
localAsn	Yes	integer	10012		Local ASN (autonomous system number). This is the ASN of your virtual device.
localIpAddress	Yes	string	100.210.1.221/30		Local IP Address. This is the IP address of the virtual device in CIDR format.
remoteAsn	Yes	integer	10013		Remote ASN (autonomous system number). This is the ASN of the cloud service provider.
remoteIpAddress	Yes	string	100.210.1.31		Remote IP address. This is the IP address of the cloud service provider.

Sample response:

The description of the response payload:

Field	Type	Example Values	Description
uuid	string	ec68e425-f973-452e-a866-76be5844d0ba	Unique Id of the of the updated BGP peering.