Skip to content

routing_domain

Overview

API to add, delete, get and modify global routing domains

Version information

Version : v2

URI scheme

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

Tags

  • routing_domain : Operations related to routing_domain

Paths

POST operation for routing_domain

POST /routing_domain

Description

Use this operation to add global routing domains

Parameters

Type Name Schema
Body body
optional
routing_domain_request_schema

Responses

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

  • routing_domain

Get operation for routing_domain

GET /routing_domain

Description

Use this operation to get the global routing domains

Responses

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

  • routing_domain

PUT operation for routing_domain

PUT /routing_domain

Description

Use this operation to modify global routing domains

Responses

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

Produces

  • application/json

Tags

  • routing_domain

DELETE operation for routing_domain

DELETE /routing_domain/{deletePathParam}

Description

Use this operation to delete global routing domains

Parameters

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

Responses

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

  • routing_domain

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

id

Auto-generated ID to uniquely identify Routing Domain

Type : integer

name

The name for the Routing Domain

Type : string

package_name

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

Type : string

properties

Properties for the routing domain

Name Description Schema
is_default
optional
Set to true to use as the default domain for the network boolean
redirect_to_wanop
optional
Set to true to optimize traffic from this domain boolean

routing_domain

Name Schema
id
optional
id
name
optional
name
package_name
optional
package_name
properties
optional
properties

routing_domain_delete_success_schema

Name Schema
routing_domain
optional
routing_domain

routing_domain

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

routing_domain_post_success_schema

Name Schema
routing_domain
optional
routing_domain

routing_domain

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

routing_domain_put_success_schema

Name Schema
routing_domain
optional
routing_domain

routing_domain

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

routing_domain_request_schema

Name Schema
routing_domain
optional
routing_domain

routing_domain_response_schema

Type : < routing_domain_response_schema > array

routing_domain_response_schema

Name Schema
id
optional
id
name
optional
name
package_name
optional
package_name
properties
optional
properties