internet_service_rules¶
Overview¶
API to add, modify, delete, and get Internet Services Rules
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- internet_service_rules : Operations related to internet_service_rules
Paths¶
POST operation for internet_service_rules¶
POST /internet_service_rules
Description¶
Use this operation to add Internet Services Rules
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | internet_service_rules_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¶
- internet_service_rules
Get operation for internet_service_rules¶
GET /internet_service_rules
Description¶
Use this operation to get Internet Services Rules
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | internet_service_rules_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¶
- internet_service_rules
PUT operation for internet_service_rules¶
PUT /internet_service_rules
Description¶
Use this operation to modify Internet Services Rules
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
internet_service_rules_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | internet_service_rules_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¶
- internet_service_rules
DELETE operation for internet_service_rules¶
DELETE /internet_service_rules/{deletePathParam}
Description¶
Use this operation to delete Internet Services Rules
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | deletePathParam required |
Object Primary Key for DELETE operation | object |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource delete added | internet_service_rules_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¶
- internet_service_rules
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
id¶
Id of rule
Type : integer
internet_service_rules¶
| Name | Schema |
|---|---|
| id optional |
id |
| order optional |
order |
| package_name optional |
package_name |
| properties optional |
properties |
| site_name optional |
site_name |
internet_service_rules_delete_success_schema¶
| Name | Schema |
|---|---|
| internet_service_rules optional |
internet_service_rules |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
internet_service_rules_post_success_schema¶
| Name | Schema |
|---|---|
| internet_service_rules optional |
internet_service_rules |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
internet_service_rules_put_success_schema¶
| Name | Schema |
|---|---|
| internet_service_rules optional |
internet_service_rules |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
internet_service_rules_request_schema¶
| Name | Schema |
|---|---|
| internet_service_rules optional |
internet_service_rules |
internet_service_rules_response_schema¶
Type : < internet_service_rules_response_schema > array
internet_service_rules_response_schema
| Name | Schema |
|---|---|
| id optional |
id |
| order optional |
order |
| package_name optional |
package_name |
| properties optional |
properties |
| site_name optional |
site_name |
order¶
The order/precedence in which Rules are applied (automatically redistributed)
Type : integer
package_name¶
Package name to add rule to
Type : string
properties¶
Internet Service Rules Properties
| Name | Description | Schema |
|---|---|---|
| destination_ip_address optional |
The Destination IP Address and subnet mask that this rule will match. | string |
| destination_port optional |
If set, the Destination Port or Port range (eg: 2345-2457) that this rule will match. | string |
| dscp optional |
The DSCP tag in the IP header that this rule will match. Default : "any" |
enum (any, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, default, ef) |
| enable_passive_ftp_detection optional |
If enabled, this parameter will make processing decisions based upon user data. | boolean |
| mode optional |
The destination service that flows should go to Default : "wan_link" |
enum (override_service, wan_link) |
| override_service optional |
The destination service that flows should go to | string |
| protocol optional |
The Protocol Name that this filter will match. Default : "ANY" |
enum (FTP, SMTP, POP3, IMAP, HTTP, TELNET, ICMP, HTTPS, ALTHTTP, SSH, DNS, NTP, SNMP, SNMPTRAP, RPC, RDP, IPSEC, SIP, ICACGPUDP, ICAUDP, ICACGP, ICA, IPERF, CIFS, LDAP, NETBIOS, RTP, RTCP, DHCP, NFS, GRE, TCP, UDP, Number, ANY) |
| protocol_num optional |
The Protocol Number that this filter will match. | integer |
| rebind_flow_on_change optional |
If enabled, flows which are otherwise identical in terms of match criteria will be treated as separate if their DSCP fields differ. | boolean |
| routing_domain optional |
Choose one of the configured Routing Domains. Leave blank or any for Any Routing Domain | string |
| rule_group_name optional |
A name given to a rule that will allow rule statistics to be summed in groups when they are displayed. All rule statistics for rules with the same Rule Group Name can be viewed together. Default : "NONE" |
enum (NONE, FTP, SMTP, POP3, IMAP, HTTP, TELNET, ICMP, HTTPS, ALTHTTP, SSH, DNS, SNMP, NTP, SNMPTRAP, RDP, IPSEC, RPC, SIP, ICACGPPUDP, ICAUDP, ICACGP, ICA, IPERF, CIFS, LDAP, NETBIOS, GRE, TCP, UDP, Number, RTP, RTCP, DHCP, NFS) |
| source_ip_address optional |
The Source IP Address and subnet mask that this rule will match. | string |
| source_port optional |
If set, the Source or Destination Port or Port range (eg: 2345-2457) that this rule will match. | string |
| vlan_id optional |
The Ethernet VLAN tag that this rule will match. | string |
| wan_link optional |
The destination service that flows should go to | string |
site_name¶
Site name to which the rule belongs
Type : string