Back to top

BGP Sessions

BGP Session Management

Retrieve all BGP sessions
GET
/devices/{id}/bgp/sessions

Provides a listing of available BGP sessions for the device.

  • Parameters
  • id
    string  (required) in path

    Device UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"bgp_sessions": [
    		{
    			"id": "string",
    			"status": "string",
    			"learned_routes": [
    				"string"
    			],
    			"address_family": "string",
    			"device": {
    				"href": "string"
    			},
    			"href": "string"
    		}
    	]
    }
  • Response  401   unauthorized
  • Response  403   forbidden
Create a BGP session
/devices/{id}/bgp/sessions

Creates a BGP session.

  • Parameters
  • id
    string  (required) in path

    Device UUID

    address_family
    string  (required) in query

    address family for BGP session

  • Response  201   created
  • {
    	"id": "string",
    	"status": "string",
    	"learned_routes": [
    		"string"
    	],
    	"address_family": "string",
    	"device": {
    		"href": "string"
    	},
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  422   unprocessable entity
Retrieve a BGP session
GET
/bgp/sessions/{id}

Returns a BGP session

  • 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
  • Response  200   ok
  • {
    	"id": "string",
    	"status": "string",
    	"learned_routes": [
    		"string"
    	],
    	"address_family": "string",
    	"device": {
    		"href": "string"
    	},
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Delete the BGP session
/bgp/sessions/{id}

Deletes the BGP session.

  • Parameters
  • id
    string  (required) in path

    BGP session UUID

  • Response  204   no content
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found