Skip to content

community_string_list

Overview

API to add, delete, get, modify community string list for BGP - Community string list for BGP - a collection of BGP communities that can be used for route filtering. The community list can also be used to set, or modify the communities of a matching route.

Version information

Version : v2

URI scheme

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

Tags

  • community_string_list : Operations related to community_string_list

Paths

POST operation for community_string_list

POST /community_string_list

Description

Use this operation to add Community String Lists

Responses

HTTP Code Description Schema
200 Resource successfully added community_string_list_post_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

Produces

  • application/json

Tags

  • community_string_list

Get operation for community_string_list

GET /community_string_list

Description

Use this operation to get the Community String Lists

Responses

HTTP Code Description Schema
200 API Successfully executed community_string_list_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

  • community_string_list

PUT operation for community_string_list

PUT /community_string_list

Description

Use this operation to modify Community String Lists

Parameters

Type Name Schema
Body body
optional
community_string_list_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added community_string_list_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

  • community_string_list

DELETE operation for community_string_list

DELETE /community_string_list/{deletePathParam}

Description

Use this operation to delete Community String Lists

Parameters

Type Name Description Schema
Path deletePathParam
required
Object Primary Key for DELETE operation object

Responses

HTTP Code Description Schema
200 Resource delete added community_string_list_delete_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

Produces

  • application/json

Tags

  • community_string_list

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

community_string

Community Strings for BGP

Type : < community_string > array

community_string

Name Description Schema
community_string_asn
optional
Autonomous system number for which the BGP community is applicable. integer
community_string_value
optional
Value for BGP community integer
id
optional
Auto-generated ID to uniquely identify community strings integer
is_new_format
optional
Use new format(aa:nn) for bgp community. boolean
well_known_selection
optional
Select a well known BGP community (no_export, no_advertise) or manually enter bgp community. enum (manual, no_export, no_advertise)

community_string_list

Name Schema
community_string
optional
community_string
id
optional
id
name
optional
name
package_name
optional
package_name
site_name
optional
site_name

community_string_list_delete_success_schema

Name Schema
community_string_list
optional
community_string_list

community_string_list

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

community_string_list_post_success_schema

Name Schema
community_string_list
optional
community_string_list

community_string_list

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

community_string_list_put_success_schema

Name Schema
community_string_list
optional
community_string_list

community_string_list

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

community_string_list_request_schema

Name Schema
community_string_list
optional
community_string_list

community_string_list_response_schema

Type : < community_string_list_response_schema > array

community_string_list_response_schema

Name Schema
community_string
optional
community_string
id
optional
id
name
optional
name
package_name
optional
package_name
site_name
optional
site_name

id

Auto-generated ID to uniquely identify Community String List

Type : integer

name

The name of the Community String List.

Type : string

package_name

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

Type : string

site_name

Site Name

Type : string