Skip to main content
Index

BGP

GET BGP

GET /ne/v1/services/bgp

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

 

Returns BGP configurations. 

 

To obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

Sample curl request:  

curl -X

GET "https://api.equinix.com/ne/v1/services/bgp"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

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.
pageNumber No integer 1   Page number. Default value=1
size No integer 100   Results per page. Default value=100

 

Sample response:

{
    "totalCount": 2,
    "pageNumber": 1,
    "pageSize": 2,
    "list": [
        {
            "uuid": "7ab1bdca-0d56-457a-bbfe-4583082c721c",
            "connectionUUID": "fbb0667d-0323-4734-855f-695cf543c2d7",
            "virtualDeviceUUID": "a75fe919-7b95-4be4-ba13-20f678fe83c6",
            "localIpAddress": "172.16.212.213/30",
            "localAsn": 2126,
            "remoteAsn": 2226,
            "remoteIpAddress": "172.16.212.214",
            "state": "Established",
            "createdBy": "nfv-sit1",
            "createdByFullName": "nfv-sit1 nfv-sit1",
            "createdDate": "2019-10-14T22:07:13.701Z",
            "createdByEmail": "shafina.ahamed@ap.equinix.com",
            "provisioningStatus": "PROVISIONED"
        },
        {
            "uuid": "8be2c356-ca90-4a75-b42a-7cd6dfbe8ead",
            "connectionUUID": "d2572f95-03e2-4ff2-89a3-7221d7048a20",
            "virtualDeviceUUID": "a75fe919-7b95-4be4-ba13-20f678fe83c6",
            "localIpAddress": "172.16.224.225/30",
            "localAsn": 2126,
            "remoteAsn": 2326,
            "remoteIpAddress": "172.16.224.226",
            "state": "Established",
            "createdBy": "nfv-sit1",
            "createdByFullName": "nfv-sit1 nfv-sit1",
            "createdDate": "2019-10-14T22:29:39.052Z",
            "createdByEmail": "shafina.ahamed@ap.equinix.com",
            "provisioningStatus": "PROVISIONED"
        }
    ]
}

 

The description of the response payload:

Field Type Example Values

Description

 

totalCount integer 200 Total count.
pageNumber integer 5 Page number.
pageSize integer 20 Results per page.
list 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.

 

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

GET BGP {bgpuuid}

GET /ne/v1/services/bgp/{bgpuuid}

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

 

Returns the BGP configuration by its bgpUUID.

 

To obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

Sample curl request:  

curl -X

GET "https://api.equinix.com/ne/v1/services/bgp/7ef81cbe-01ed-4c27-8b2f-69d3a3fd4d6a"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

Path parameter:

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

 

Sample response:

{
    "uuid": "7ab1bdca-0d56-457a-bbfe-4583082c721c",
    "connectionUUID": "fbb0667d-0323-4734-855f-695cf543c2d7",
    "virtualDeviceUUID": "a75fe919-7b95-4be4-ba13-20f678fe83c6",
    "localIpAddress": "100.210.1.221/30",
    "localAsn": 10012,
    "remoteAsn": 10013,
    "remoteIpAddress": "100.210.1.222",
    "authenticationKey": "pass123",
    "state": "Established",
    "createdBy": "nfv-sit1",
    "createdByFullName": "nfv-sit1 nfv-sit1",
    "createdDate": "2019-10-14T22:07:13.701Z",
    "createdByEmail": "shafina.ahamed@ap.equinix.com",
    "lastUpdatedBy": "nfv-sit1",
    "lastUpdatedByFullName": "nfv-sit1 nfv-sit1",
    "lastUpdatedDate": "2019-10-16T21:00:30.539Z",
    "lastUpdatedByEmail": "shafina.ahamed@ap.equinix.com",
    "provisioningStatus": "PENDING_UPDATE"
}

 

The description of the response payload:

Field Type Example Values

Description

 

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, or FAILED.

 

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

GET BGP configuration {connUUID}

GET /ne/v1/services/bgp/connection/{connectionUUID}

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

 

Returns the BGP configuration by its connection (connectionUUID). 

 

To obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

Sample curl request:  

curl -X

GET "https://api.equinix.com/ne/v1/services/bgp/connection/7ef81cbe-01ed-4c27-8b2f-69d3a3fd4d6a"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

Path parameter:

Path Parameter Name Mandatory Type Example Applicable Values Description
connectionUUID Yes string 7ef81cbe-01ed-4c27-8b2f-69d3a3fd4d6a   Unique Id of the connection.

 

Sample response:

{
    "uuid": "7ab1bdca-0d56-457a-bbfe-4583082c721c",
    "connectionUUID": "fbb0667d-0323-4734-855f-695cf543c2d7",
    "virtualDeviceUUID": "a75fe919-7b95-4be4-ba13-20f678fe83c6",
    "localIpAddress": "100.210.1.221/30",
    "localAsn": 10012,
    "remoteAsn": 10013,
    "remoteIpAddress": "100.210.1.222",
    "authenticationKey": "pass123",
    "state": "Established",
    "createdBy": "nfv-sit1",
    "createdByFullName": "nfv-sit1 nfv-sit1",
    "createdDate": "2019-10-14T22:07:13.701Z",
    "createdByEmail": "shafina.ahamed@ap.equinix.com",
    "lastUpdatedBy": "nfv-sit1",
    "lastUpdatedByFullName": "nfv-sit1 nfv-sit1",
    "lastUpdatedDate": "2019-10-16T21:00:30.539Z",
    "lastUpdatedByEmail": "shafina.ahamed@ap.equinix.com",
    "provisioningStatus": "PENDING_UPDATE"
}

 

The description of the response payload:

Field Type Example Values

Description

 

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, or FAILED.

 

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

PUT BGP {uuid}

PUT /ne/v1/services/bgp/{uuid}

 Method  PUT
 URL or End Point  /ne/v1/services/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. 

 

To obtain an authorization key, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

Sample curl request:

curl -X

PUT "https://api.equinix.com/ne/v1/services/bgp/ec68e425-f973-452e-a866-76be5844d0ba"

-H "Authorization: Bearer CcYxLosIYIIsmCGav5pplU25dLkG"
-H "Content-Type: application/json"
-d '{
  "authenticationKey": "sroy001",
  "localAsn": 10012,
  "localIpAddress": "10.0.0.1/29",
  "remoteAsn": 10013,
  "remoteIpAddress": "10.0.0.2"
}'

 

Path parameter:

Path Parameter Mandatory Type Example Possible Values Description
uuid Yes string 7ab1bdca-0d56-457a-bbfe-4583082c721c   Unique Id of the 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:

{
    "uuid": "ec68e425-f973-452e-a866-76be5844d0ba"
}

 

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.

 

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