Skip to content

bgp_properties

Overview

API to edit basic properties for BGP

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP

Tags

  • bgp_properties : Operations related to bgp_properties

Paths

Get operation for bgp_properties

GET /bgp_properties

Description

Use this operation to get the basic BGP properties

Responses

HTTP Code Description Schema
200 API Successfully executed bgp_properties_response_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • bgp_properties

PUT operation for bgp_properties

PUT /bgp_properties

Description

Use this operation to modify the basic BGP properties

Parameters

Type Name Schema
Body body
optional
bgp_properties_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added bgp_properties_put_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Consumes

  • application/json

Produces

  • application/json

Tags

  • bgp_properties

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

advertise_ospf_routes

Set to true to allow routes learnt from OSPF peers to be advertised via BGP.

Type : boolean

advertise_sdwan_routes

Set to true to allow SD-WAN routes to be advertised via BGP.

Type : boolean

bgp_properties

Name Schema
advertise_ospf_routes
optional
advertise_ospf_routes
advertise_sdwan_routes
optional
advertise_sdwan_routes
enable
optional
enable
local_autonomous_system
optional
local_autonomous_system
package_name
optional
package_name
router_id
optional
router_id
site_name
optional
site_name

bgp_properties_delete_success_schema

Name Schema
bgp_properties
optional
bgp_properties

bgp_properties

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

bgp_properties_post_success_schema

Name Schema
bgp_properties
optional
bgp_properties

bgp_properties

Name Description Schema
message
optional
Example : "resource added succesfully" string

bgp_properties_put_success_schema

Name Schema
bgp_properties
optional
bgp_properties

bgp_properties

Name Description Schema
message
optional
Example : "resource modified succesfully" string

bgp_properties_request_schema

Name Schema
bgp_properties
optional
bgp_properties

bgp_properties_response_schema

Type : < bgp_properties_response_schema > array

bgp_properties_response_schema

Name Schema
advertise_ospf_routes
optional
advertise_ospf_routes
advertise_sdwan_routes
optional
advertise_sdwan_routes
enable
optional
enable
local_autonomous_system
optional
local_autonomous_system
package_name
optional
package_name
router_id
optional
router_id
site_name
optional
site_name

enable

Set to true to enable BGP.

Type : boolean

local_autonomous_system

Enter the Local Autonomous System number to learn routes from and advertise routes to. This must match what is configured on the neighboring routers.

Type : integer

package_name

Config package name using which the site API operation should be performed.

Type : string

router_id

A unique identifier, in IPv4 format, used for BGP advertisements

Type : string

site_name

Site Name

Type : string