site_routing_domain¶
Overview¶
API to get and modify site routing domains.
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- site_routing_domain : Operations related to site_routing_domain
Paths¶
Get operation for site_routing_domain¶
GET /site_routing_domain
Description¶
Use this operation to get the list of site routing domains
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | site_routing_domain_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_routing_domain
PUT operation for site_routing_domain¶
PUT /site_routing_domain
Description¶
Use this operation to modify properties of site routing domain
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
site_routing_domain_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | site_routing_domain_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¶
- site_routing_domain
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
name¶
Site Routing Domain
Type : string
package_name¶
Config package name using which the site API operation should be performed.
Type : string
site_name¶
Site Name
Type : string
site_routing_domain¶
| Name | Schema |
|---|---|
| name optional |
name |
| package_name optional |
package_name |
| site_name optional |
site_name |
| site_routing_domain_properties optional |
site_routing_domain_properties |
site_routing_domain_delete_success_schema¶
| Name | Schema |
|---|---|
| site_routing_domain optional |
site_routing_domain |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
site_routing_domain_post_success_schema¶
| Name | Schema |
|---|---|
| site_routing_domain optional |
site_routing_domain |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
site_routing_domain_properties¶
Site Routing Domain properties
Type : < site_routing_domain_properties > array
site_routing_domain_properties
| Name | Description | Schema |
|---|---|---|
| enabled optional |
enable/disable routing domain to be available for the site Default : true |
boolean |
| is_default optional |
enable/disable routing domain as default domain for the site Default : false |
boolean |
| redirect_to_wanop optional |
enable/disable optimizing of routing domain traffic Default : false |
boolean |
site_routing_domain_put_success_schema¶
| Name | Schema |
|---|---|
| site_routing_domain optional |
site_routing_domain |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
site_routing_domain_request_schema¶
| Name | Schema |
|---|---|
| site_routing_domain optional |
site_routing_domain |
site_routing_domain_response_schema¶
Type : < site_routing_domain_response_schema > array
site_routing_domain_response_schema
| Name | Schema |
|---|---|
| name optional |
name |
| package_name optional |
package_name |
| site_name optional |
site_name |
| site_routing_domain_properties optional |
site_routing_domain_properties |