BGP

Manage BGP configs and sessions. See device endpoints to create and list BGP sessions for a particular device. Check out the product docs to learn more about Local and Global BGP.

Requesting bgp config

/projects/{id}/bgp-configs

Requests to enable bgp configuration for a project.

    /projects/{id}/bgp-configs
  • Parameters
  • id
    string  (required) in path

    Project UUID

    bgp_config_request
     (required) in body

    BGP config Request to create

    deployment_type, asn

    {
    	"deployment_type": "string",
    	"asn": "integer",
    	"md5": "string",
    	"use_case": "string"
    } 

Retrieve a bgp config

GET
/projects/{id}/bgp-config

Returns a bgp config

    /projects/{id}/bgp-config
  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Retrieve BGP neighbor data for this device

GET
/devices/{id}/bgp/neighbors

Provides a summary of the BGP neighbor data associated to the BGP sessions for this device.

Retrieve all BGP sessions for project

GET
/projects/{id}/bgp/sessions

Provides a listing of available BGP sessions for the project.

Retrieve all BGP sessions

GET
/devices/{id}/bgp/sessions

Provides a listing of available BGP sessions for the device.

Create a BGP session

/devices/{id}/bgp/sessions

Creates a BGP session.

    /devices/{id}/bgp/sessions
  • Parameters
  • id
    string  (required) in path

    Device UUID

    bgp_session
     (required) in body

    BGP session to create

    {
    	"address_family": "string",
    	"default_route": "boolean"
    } 

Retrieve a BGP session

GET
/bgp/sessions/{id}

Returns a BGP session

    /bgp/sessions/{id}
  • Parameters
  • id
    string  (required) in path

    BGP session UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Delete the BGP session

/bgp/sessions/{id}

Deletes the BGP session.

    /bgp/sessions/{id}
  • Parameters
  • id
    string  (required) in path

    BGP session UUID

Update the BGP session

PUT
/bgp/sessions/{id}

Updates the BGP session by either enabling or disabling the default route functionality.

    /bgp/sessions/{id}
  • Parameters
  • id
    string  (required) in path

    BGP session UUID

    default_route
     (required) in body

    Default route