rule_groups¶
Overview¶
API to add, delete, get, modify rule groups
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- rule_groups : Operations related to rule_groups
Paths¶
POST operation for rule_groups¶
POST /rule_groups
Description¶
Use this operation to add rule groups
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | rule_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¶
- rule_groups
Get operation for rule_groups¶
GET /rule_groups
Description¶
Use this operation to get the rule groups
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | rule_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¶
- rule_groups
PUT operation for rule_groups¶
PUT /rule_groups
Description¶
Use this operation to modify rule groups
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
rule_groups_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | rule_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¶
- rule_groups
DELETE operation for rule_groups¶
DELETE /rule_groups/{deletePathParam}
Description¶
Use this operation to delete rule 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 | rule_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¶
- rule_groups
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
id¶
Auto-generated ID to uniquely identify the rule group
Type : integer
name¶
The name for the rule 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 |
|---|---|---|
| enable_mos optional |
Enabling this field gathers statistics for the application at the WAN to LAN side of the Virtual Path, and derives a quality score for that application as if that application were a VOIP call | boolean |
rule_groups¶
| Name | Schema |
|---|---|
| id optional |
id |
| name optional |
name |
| package_name optional |
package_name |
| properties optional |
properties |
rule_groups_delete_success_schema¶
| Name | Schema |
|---|---|
| rule_groups optional |
rule_groups |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
rule_groups_post_success_schema¶
| Name | Schema |
|---|---|
| rule_groups optional |
rule_groups |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
rule_groups_put_success_schema¶
| Name | Schema |
|---|---|
| rule_groups optional |
rule_groups |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
rule_groups_request_schema¶
| Name | Schema |
|---|---|
| rule_groups optional |
rule_groups |
rule_groups_response_schema¶
Type : < rule_groups_response_schema > array
| Name | Schema |
|---|---|
| id optional |
id |
| name optional |
name |
| package_name optional |
package_name |
| properties optional |
properties |