Skip to content

autopath_groups

Overview

API to add, delete, get, modify autopath groups

Version information

Version : v2

URI scheme

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

Tags

  • autopath_groups : Operations related to autopath_groups

Paths

POST operation for autopath_groups

POST /autopath_groups

Description

Use this operation to add autopath groups

Responses

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

  • autopath_groups

Get operation for autopath_groups

GET /autopath_groups

Description

Use this operation to get the autopath groups

Responses

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

  • autopath_groups

PUT operation for autopath_groups

PUT /autopath_groups

Description

Use this operation to modify autopath groups

Parameters

Type Name Schema
Body body
optional
autopath_groups_request_schema

Responses

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

  • autopath_groups

DELETE operation for autopath_groups

DELETE /autopath_groups/{deletePathParam}

Description

Use this operation to delete autopath groups

Parameters

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

Responses

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

  • autopath_groups

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

autopath_groups

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

autopath_groups_delete_success_schema

Name Schema
autopath_groups
optional
autopath_groups

autopath_groups

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

autopath_groups_post_success_schema

Name Schema
autopath_groups
optional
autopath_groups

autopath_groups

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

autopath_groups_put_success_schema

Name Schema
autopath_groups
optional
autopath_groups

autopath_groups

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

autopath_groups_request_schema

Name Schema
autopath_groups
optional
autopath_groups

autopath_groups_response_schema

Type : < autopath_groups_response_schema > array

autopath_groups_response_schema

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

id

Auto-generated ID to uniquely identify autopath group

Type : integer

name

The name for the autopath group

Type : string

package_name

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

Type : string

properties

Properties for the autopath group

Name Description Schema
bad_loss_sensitive
optional
If Bad Loss Sensitive is set to Enable, Paths will be marked BAD due to loss AND will incur a Path scoring penalty. Setting this option to Disable may be useful when the loss of bandwidth is intolerable. Custom settings allow you to specify the percentage of loss over time required to mark a Path BAD. enum (enable, disable, custom)
enable_encryption
optional
If enabled, packets sent along this Path will be encrypted boolean
instability_sensitive
optional
If you enable Instability Sensitive, latency penalties due to the Path being in a BAD state AND other latency spikes are considered in the Path scoring algorithm. boolean
ip_dscp_tagging
optional
The DSCP Tag to set in the IP header for Path traffic enum (any, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, default, ef)
over_time_ms
optional
Specify the time period, in milliseconds, over which Percent Loss is measured. integer
path_probation_period_ms
optional
Specify the wait time, OR Path Probation Period, before a Path transitions from BAD to GOOD. The default is 10 seconds. integer
percent_loss
optional
The Percent Loss is the percentage of packet loss observed before a Path is marked BAD which measured Over Time. By default, packet loss is based on the last 200 packets received. Use the drop-down menus to configure Percent Loss AND Over Time. enum (default, 1, 2, 3, 4, 5, 10, 20, 30, 40, 50, 60, 70, 80, 90)
set_as_default
optional
If enabled, this group will be used as the default Autopath Group for WAN Link Usages boolean
silence_period_ms
optional
Specify silence duration before Path state transitions from GOOD to BAD. When not specified, the default is 150ms. string