Skip to content

site

Overview

API to add, modify, delete, and get sites.

Version information

Version : v2

URI scheme

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

Tags

  • site : Operations related to site

Paths

POST operation for site

POST /site

Description

Use this operation to add site

Parameters

Type Name Schema
Body body
optional
site_request_schema

Responses

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

Consumes

  • application/json

Produces

  • application/json

Tags

  • site

Get operation for site

GET /site

Description

Use this operation to get the list of sites

Responses

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

  • site

PUT operation for site

PUT /site

Description

Use this operation to modify site

Responses

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

Produces

  • application/json

Tags

  • site

DELETE operation for site

DELETE /site/{deletePathParam}

Description

Use this operation to delete a site

Parameters

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

Responses

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

  • site

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

mode

Operating mode of this site

Type : enum (primary_mcn, secondary_mcn, primary_rcn, secondary_rcn, client)

model

site model

Type : enum (cb210, cb400, cb410, cb1000, cb2000, cb2100, cb4000, cb4100, cb5100, cbvpx, cbvpxl)

package_name

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

Type : string

persist_ucast_refresh_time_ms

Gateway ARP Timer: (ms)

Type : integer

region

Region to which the site belongs to

Type : string

secure_key

Hexadecimal secure key used for encryption and membership verification in the Virtual WAN network. This field is optional. If the value is not provided, API generates the secure key.

Type : string

site

Name Schema
mode
optional
mode
model
optional
model
package_name
optional
package_name
persist_ucast_refresh_time_ms
optional
persist_ucast_refresh_time_ms
region
optional
region
secure_key
optional
secure_key
site_location
optional
site_location
site_name
optional
site_name
user_ucast_refresh_time_ms
optional
user_ucast_refresh_time_ms

site_delete_success_schema

Name Schema
site
optional
site

site

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

site_location

Site location.

Type : string

site_name

Site Name

Type : string

site_post_success_schema

Name Schema
site
optional
site

site

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

site_put_success_schema

Name Schema
site
optional
site

site

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

site_request_schema

Name Schema
site
optional
site

site_response_schema

Type : < site_response_schema > array

site_response_schema

Name Schema
mode
optional
mode
model
optional
model
package_name
optional
package_name
persist_ucast_refresh_time_ms
optional
persist_ucast_refresh_time_ms
region
optional
region
secure_key
optional
secure_key
site_location
optional
site_location
site_name
optional
site_name
user_ucast_refresh_time_ms
optional
user_ucast_refresh_time_ms

user_ucast_refresh_time_ms

Host ARP Timer: (ms)

Type : integer