Resource: reset
Reset all appflow configuration back to the factory default
http://{device}/api/sh.appflow/2.0/reset
null
| Property Name | Type | Description | Notes |
|---|---|---|---|
| reset | <null> | Reset all appflow configuration back to the factory default |
Links
reset: set
POST http://{device}/api/sh.appflow/2.0/reset
Request Body
Do not provide a request body.
Response BodyOn success, the server does not provide any body in the responses.
Resource: dpi_info
Holds information about the DPI library that identifies Layer 7 protocols and built-in Applications in this version of the API.
http://{device}/api/sh.appflow/2.0/dpi_info
{ "version": string }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| dpi_info | <object> | Holds information about the DPI library that identifies Layer 7 protocols and built-in Applications in this version of the API. | Read-only; |
| dpi_info.version | <string> | The DPI version number. Incremented every time the DPI library is updated. | Read-only; Optional; |
Links
dpi_info: get
GET http://{device}/api/sh.appflow/2.0/dpi_info
Response Body
Returns a dpi_info data object.
Resource: business_criticalities
List of Business Criticalities. Business Criticality is one of the required properties of an Application and represents the business importance of an Application. This is a static list that cannot be modified.
http://{device}/api/sh.appflow/2.0/business_criticalities{?name}
[ { "id": integer, "name": string } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| business_criticalities | <array of <object>> | List of Business Criticalities. Business Criticality is one of the required properties of an Application and represents the business importance of an Application. This is a static list that cannot be modified. | |
| business_criticalities[items] | <object> | Read-only; | |
| id | <integer> | Business Criticality ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Business Criticality | Read-only; Pattern: '^(\S.*)?\S$'; |
Links
business_criticalities: get
GET http://{device}/api/sh.appflow/2.0/business_criticalities{?name}
Response Body
Returns a business_criticalities data object.
Resource: categories
List of Categories. Category is one of the required properties of an Application and represents the general function of an Application. This is a static list that cannot be modified.
http://{device}/api/sh.appflow/2.0/categories{?name}
[ { "id": integer, "name": string } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| categories | <array of <object>> | List of Categories. Category is one of the required properties of an Application and represents the general function of an Application. This is a static list that cannot be modified. | |
| categories[items] | <object> | Read-only; | |
| id | <integer> | Category ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Category | Read-only; Pattern: '^[a-zA-Z0-9_-]+$'; |
Links
categories: get
GET http://{device}/api/sh.appflow/2.0/categories{?name}
Response Body
Returns a categories data object.
Resource: traffic_types
List of Traffic Types
http://{device}/api/sh.appflow/2.0/traffic_types{?name}
[ { "id": integer, "name": string } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| traffic_types | <array of <object>> | List of Traffic Types | |
| traffic_types[items] | <object> | ||
| id | <integer> | Traffic Type ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Traffic Type | Pattern: '^[a-zA-Z0-9_-]+$'; |
Links
traffic_types: get
GET http://{device}/api/sh.appflow/2.0/traffic_types{?name}
Response Body
Returns a traffic_types data object.
Resource: securitylevels
List of Security Levels
http://{device}/api/sh.appflow/2.0/securitylevels{?name}
[ { "id": integer, "name": string } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| securitylevels | <array of <object>> | List of Security Levels | |
| securitylevels[items] | <object> | ||
| id | <integer> | Security Level ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Security Level Name | Pattern: '^[a-zA-Z0-9_-]+$'; |
Links
securitylevels: get
GET http://{device}/api/sh.appflow/2.0/securitylevels{?name}
Response Body
Returns a securitylevels data object.
Resource: networks
List of Networks
http://{device}/api/sh.appflow/2.0/networks{?is_default,parent_id,name,virtual}
[ network ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| networks | <array of <network>> | List of Networks | |
| networks[items] | <network> | Network object |
Links
networks: create
POST http://{device}/api/sh.appflow/2.0/networks{?is_default,parent_id,name,virtual}
Request Body
Provide a network data object.
Response BodyReturns a network data object.
networks: set
PUT http://{device}/api/sh.appflow/2.0/networks{?is_default,parent_id,name,virtual}
Request Body
Provide an empty_collection data object.
Response BodyOn success, the server does not provide any body in the responses.
networks: get
GET http://{device}/api/sh.appflow/2.0/networks{?is_default,parent_id,name,virtual}
Response Body
Returns a networks data object.
Resource: network
Network object
http://{device}/api/sh.appflow/2.0/networks/items/{id}
{ "id": integer, "name": string, "seclevel_id": integer, "seclevel_name": string, "parent_id": multiple, "is_public": boolean, "is_default": boolean }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| network | <object> | Network object | Required properties: [name, seclevel_id]; |
| id | <integer> | Network ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Network Name | Pattern: '^(\S.*)?\S$'; |
| seclevel_id | <integer> | Network Security Level ID | Read-only; Range: 1 to 18446744073709551615; |
| seclevel_name | <string> | Network Security Level Name | Read-only; Pattern: '^[a-zA-Z0-9_-]+$'; |
| network.parent_id | <multiple> | The parent physical network for a virtual network. A virtual network uses a higher security level than the associated physical network | Read-only; Optional; |
| network.parent_id.anyOf[0] | <identifier> | Generic numeric identifier | Read-only; |
| network.parent_id.anyOf[1] | <null> | Read-only; | |
| network.is_public | <boolean> | Is the network public or private? | Optional; |
| network.is_default | <boolean> | Is this the default network? | Read-only; Optional; |
Links
network: get
GET http://{device}/api/sh.appflow/2.0/networks/items/{id}
Response Body
Returns a network data object.
network: set
PUT http://{device}/api/sh.appflow/2.0/networks/items/{id}
Request Body
Provide a network data object.
Response BodyReturns a network data object.
network: delete
DELETE http://{device}/api/sh.appflow/2.0/networks/items/{id}
Response Body
On success, the server does not provide any body in the responses.
Relations
network: uplinks
Related resource Variables| Related var | Data value for replacement |
|---|---|
| network_id | 0/id |
network: parent
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/parent_id |
network: child
Related resource Variables| Related var | Data value for replacement |
|---|---|
| parent_id | 0/id |
network: seclevel
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/seclevel_id |
Resource: sitetag
A Site Tag Resource
http://{device}/api/sh.appflow/2.0/sitetags/items/{id}
{ "id": identifier, "name": name, "is_built_in": boolean, "sites": [ { "id": identifier, "name": name } ] }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| sitetag | <object> | A Site Tag Resource | Required properties: [name]; |
| sitetag.id | <identifier> | Generic numeric identifier | Read-only; |
| sitetag.name | <name> | Generic name field, only alphanumeric '-' and '_' allowed | Pattern: '^[a-zA-Z0-9_-]+$'; |
| sitetag.is_built_in | <boolean> | A flag that specifies whether the tag is built in and therefore cannot be deleted. | Read-only; Optional; |
| sitetag.sites | <array of <object>> | List of sites tagged with this tag | Read-only; Optional; |
| sitetag.sites[items] | <object> | Read-only; | |
| sitetag.sites[items].id | <identifier> | Generic numeric identifier | Read-only; |
| sitetag.sites[items].name | <name> | Generic name field, only alphanumeric '-' and '_' allowed | Pattern: '^[a-zA-Z0-9_-]+$'; |
Links
sitetag: get
GET http://{device}/api/sh.appflow/2.0/sitetags/items/{id}
Response Body
Returns a sitetag data object.
sitetag: set
PUT http://{device}/api/sh.appflow/2.0/sitetags/items/{id}
Request Body
Provide a sitetag data object.
Response BodyReturns a sitetag data object.
sitetag: delete
DELETE http://{device}/api/sh.appflow/2.0/sitetags/items/{id}
Response Body
On success, the server does not provide any body in the responses.
Relations
Resource: sites
List of Sites
http://{device}/api/sh.appflow/2.0/sites{?is_local,is_default,ob_qos_profile_id,name,ib_qos_profile_id}
[ site ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| sites | <array of <site>> | List of Sites | |
| sites[items] | <site> | Site object |
Links
sites: create
POST http://{device}/api/sh.appflow/2.0/sites{?is_local,is_default,ob_qos_profile_id,name,ib_qos_profile_id}
Request Body
Provide a site data object.
Response BodyReturns a site data object.
sites: set
PUT http://{device}/api/sh.appflow/2.0/sites{?is_local,is_default,ob_qos_profile_id,name,ib_qos_profile_id}
Request Body
Provide an empty_collection data object.
Response BodyOn success, the server does not provide any body in the responses.
sites: get
GET http://{device}/api/sh.appflow/2.0/sites{?is_local,is_default,ob_qos_profile_id,name,ib_qos_profile_id}
Response Body
Returns a sites data object.
Resource: site
Site object
http://{device}/api/sh.appflow/2.0/sites/items/{id}
{ "id": integer, "name": string, "is_local": boolean, "is_default": boolean, "tags": [ { "id": identifier, "name": string, "is_built_in": boolean } ], "ob_qos_profile_id": integer, "ob_qos_profile": string, "ib_qos_profile_id": integer, "ib_qos_profile": string }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| site | <object> | Site object | Required properties: [name, is_local]; |
| id | <integer> | Site ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Site Name | Pattern: '^(\S.*)?\S$'; |
| site.is_local | <boolean> | Is the site local or remote? | |
| site.is_default | <boolean> | Is this the default site? | Read-only; Optional; |
| site.tags | <array of <object>> | Optional; | |
| site.tags[items] | <object> | Required properties: [id]; | |
| site.tags[items].id | <identifier> | Generic numeric identifier | Read-only; |
| name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| site.tags[items].is_built_in | <boolean> | Read-only; Optional; | |
| ob_qos_profile_id | <integer> | Outbound QoS profile ID | Read-only; Range: 1 to 18446744073709551615; |
| site.ob_qos_profile | <string> | Outbound QoS profile name | Read-only; Optional; |
| ib_qos_profile_id | <integer> | Inbound QoS profile ID | Read-only; Range: 1 to 18446744073709551615; |
| site.ib_qos_profile | <string> | Inbound QoS profile name | Read-only; Optional; |
Links
site: get
GET http://{device}/api/sh.appflow/2.0/sites/items/{id}
Response Body
Returns a site data object.
site: set
PUT http://{device}/api/sh.appflow/2.0/sites/items/{id}
Request Body
Provide a site data object.
Response BodyReturns a site data object.
site: delete
DELETE http://{device}/api/sh.appflow/2.0/sites/items/{id}
Response Body
On success, the server does not provide any body in the responses.
Relations
site: ob_qos_profile
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/ob_qos_profile_id |
site: ib_qos_profile
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/ib_qos_profile_id |
Resource: areas
List of Areas
http://{device}/api/sh.appflow/2.0/areas{?display_id,is_default,site_id}
[ area ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| areas | <array of <area>> | List of Areas | |
| areas[items] | <area> | Area Object, i.e., subnets rechability for peers. |
Links
areas: create
POST http://{device}/api/sh.appflow/2.0/areas{?display_id,is_default,site_id}
Request Body
Provide an area data object.
Response BodyReturns an area data object.
areas: get
GET http://{device}/api/sh.appflow/2.0/areas{?display_id,is_default,site_id}
Response Body
Returns an areas data object.
areas: set
PUT http://{device}/api/sh.appflow/2.0/areas{?display_id,is_default,site_id}
Request Body
Provide an empty_collection data object.
Response BodyOn success, the server does not provide any body in the responses.
Resource: area
Area Object, i.e., subnets rechability for peers.
http://{device}/api/sh.appflow/2.0/areas/items/{id}{?is_default}
{ "id": integer, "site_id": integer, "site_name": string, "display_id": integer, "is_default": boolean, "peers": [ ipv4address ], "subnets": [ ipv4prefix ] }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| area | <object> | Area Object, i.e., subnets rechability for peers. | Required properties: [site_id, peers, subnets]; |
| id | <integer> | Area ID | Read-only; Range: 1 to 18446744073709551615; |
| site_id | <integer> | Reference to the Site | Read-only; Range: 1 to 18446744073709551615; |
| site_name | <string> | Site Name | Read-only; Pattern: '^(\S.*)?\S$'; |
| display_id | <integer> | Display ID. Auto-incrementing, and unique within the site | Read-only; Range: 1 to 18446744073709551615; |
| area.is_default | <boolean> | Is the default area ? | Read-only; Optional; |
| area.peers | <array of <ipv4address>> | List of Peers | |
| area.peers[items] | <ipv4address> | IPv4 address (x.y.z.k) | Pattern: '^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'; |
| area.subnets | <array of <ipv4prefix>> | List of Subnets | |
| area.subnets[items] | <ipv4prefix> | IPv4 prefix (x.y.z.k/mask) | Pattern: '^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(/(3[012]|[12]?[0-9]))$'; |
Links
area: get
GET http://{device}/api/sh.appflow/2.0/areas/items/{id}{?is_default}
Response Body
Returns an area data object.
area: set
PUT http://{device}/api/sh.appflow/2.0/areas/items/{id}{?is_default}
Request Body
Provide an area data object.
Response BodyReturns an area data object.
area: delete
DELETE http://{device}/api/sh.appflow/2.0/areas/items/{id}{?is_default}
Response Body
On success, the server does not provide any body in the responses.
Relations
Resource: uplinks
List of Uplinks
http://{device}/api/sh.appflow/2.0/uplinks{?name,network_id,site_id,virtual,is_default,parent_id,is_ps_capable}
[ { "id": integer, "name": string, "site_id": integer, "network_id": integer, "parent_id": integer, "is_default": boolean, "is_ps_capable": boolean, "interface": string } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| uplinks | <array of <object>> | List of Uplinks | |
| uplinks[items] | <object> | ||
| id | <integer> | Uplink ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Uplink Name | Pattern: '^(\S.*)?\S$'; |
| site_id | <integer> | Reference to the Site | Read-only; Range: 1 to 18446744073709551615; |
| network_id | <integer> | Reference to the Network | Read-only; Range: 1 to 18446744073709551615; |
| parent_id | <integer> | The parent physical uplink for a virtual uplink | Read-only; Range: 1 to 18446744073709551615; |
| uplinks[items].is_default | <boolean> | Is this a default uplink? | Read-only; Optional; |
| uplinks[items].is_ps_capable | <boolean> | Is this a path-selection capable uplink? | Read-only; Optional; |
| uplinks[items].interface | <string> | Steelhead Interface identifier | Optional; |
Links
uplinks: create
POST http://{device}/api/sh.appflow/2.0/uplinks{?name,network_id,site_id,virtual,is_default,parent_id,is_ps_capable}
Request Body
Provide an uplink data object.
Response BodyReturns an uplink data object.
uplinks: set
PUT http://{device}/api/sh.appflow/2.0/uplinks{?name,network_id,site_id,virtual,is_default,parent_id,is_ps_capable}
Request Body
Provide an empty_collection data object.
Response BodyOn success, the server does not provide any body in the responses.
uplinks: get
GET http://{device}/api/sh.appflow/2.0/uplinks{?name,network_id,site_id,virtual,is_default,parent_id,is_ps_capable}
Response Body
Returns an uplinks data object.
Resource: uplink
Uplink object
http://{device}/api/sh.appflow/2.0/uplinks/items/{id}
{ "id": integer, "name": string, "site_id": integer, "site_name": string, "network_id": integer, "network_name": string, "gateway_ip": string, "interface": string, "bandwidth_up": integer, "bandwidth_down": integer, "is_firewalled": boolean, "is_public": boolean, "parent_id": multiple, "probe_dscp": integer, "probe_timeout": integer, "probe_threshold": integer, "seclevel_id": integer, "is_default": boolean, "is_ps_capable": boolean }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| uplink | <object> | Uplink object | Required properties: [name, site_id, network_id, bandwidth_up, bandwidth_down]; |
| id | <integer> | Uplink ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Uplink Name | Pattern: '^(\S.*)?\S$'; |
| site_id | <integer> | Reference to the Site | Read-only; Range: 1 to 18446744073709551615; |
| site_name | <string> | Site Name | Read-only; Pattern: '^(\S.*)?\S$'; |
| network_id | <integer> | Reference to the Network | Read-only; Range: 1 to 18446744073709551615; |
| network_name | <string> | Network Name | Read-only; Pattern: '^(\S.*)?\S$'; |
| gateway_ip | <string> | IP address of the Gateway | Pattern: '^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'; |
| uplink.interface | <string> | Steelhead Interface identifier | Optional; |
| uplink.bandwidth_up | <integer> | Upload Bandwidth, in kbps | Range: 1 to 4294967295; |
| uplink.bandwidth_down | <integer> | Download Bandwidth, in kbps | Range: 1 to 4294967295; |
| uplink.is_firewalled | <boolean> | Indicates whether the SteelHead accessing this uplink is behind a firewall. | Optional; |
| uplink.is_public | <boolean> | Indicates whether the uplink network is using public addressing. | Read-only; Optional; |
| uplink.parent_id | <multiple> | The parent physical uplink for a virtual uplink. A virtual uplink uses a higher security level than the associated physical uplink. | Read-only; Optional; |
| uplink.parent_id.anyOf[0] | <identifier> | Generic numeric identifier | Read-only; |
| uplink.parent_id.anyOf[1] | <null> | Read-only; | |
| probe_dscp | <integer> | DSCP marking for path probe packets | Range: 0 to 63; |
| uplink.probe_timeout | <integer> | Timeout in seconds, for path probe packets | Optional; Range: 1 to 65535; |
| uplink.probe_threshold | <integer> | Number of probes to detect a path as UP/DOWN | Optional; Range: 1 to 65535; |
| seclevel_id | <integer> | Uplink Security level. Inherited from Network. | Read-only; Range: 1 to 18446744073709551615; |
| uplink.is_default | <boolean> | Is this a default uplink? | Read-only; Optional; |
| uplink.is_ps_capable | <boolean> | Is this a path-selection capable uplink? | Read-only; Optional; |
Links
uplink: get
GET http://{device}/api/sh.appflow/2.0/uplinks/items/{id}
Response Body
Returns an uplink data object.
uplink: set
PUT http://{device}/api/sh.appflow/2.0/uplinks/items/{id}
Request Body
Provide an uplink data object.
Response BodyReturns an uplink data object.
uplink: delete
DELETE http://{device}/api/sh.appflow/2.0/uplinks/items/{id}
Response Body
On success, the server does not provide any body in the responses.
Relations
uplink: network
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/network_id |
uplink: parent
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/parent_id |
uplink: child
Related resource Variables| Related var | Data value for replacement |
|---|---|
| parent_id | 0/id |
uplink: seclevel
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/seclevel_id |
uplink: path_rules
Related resource Variables| Related var | Data value for replacement |
|---|---|
| uplink_id | 0/id |
Resource: path_rules
List of Path-Selection Rules
http://{device}/api/sh.appflow/2.0/path_rules{?is_default,apptag_id,site_id,app_id,uplink_id}
[ { "id": identifier, "site_name": unrestricted_name, "app_name": unrestricted_name, "position": integer } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| path_rules | <array of <object>> | List of Path-Selection Rules | |
| path_rules[items] | <object> | Required properties: [id, position]; | |
| path_rules[items].id | <identifier> | Generic numeric identifier | Read-only; |
| path_rules[items].site_name | <unrestricted_name> | Generic name field, all characters allowed except for leading and trailing whitespace | Pattern: '^(\S.*)?\S$'; |
| path_rules[items].app_name | <unrestricted_name> | Generic name field, all characters allowed except for leading and trailing whitespace | Pattern: '^(\S.*)?\S$'; |
| path_rules[items].position | <integer> |
Links
path_rules: create
POST http://{device}/api/sh.appflow/2.0/path_rules{?is_default,apptag_id,site_id,app_id,uplink_id}
Request Body
Provide a path_rule data object.
Response BodyReturns a path_rule data object.
path_rules: get
GET http://{device}/api/sh.appflow/2.0/path_rules{?is_default,apptag_id,site_id,app_id,uplink_id}
Response Body
Returns a path_rules data object.
path_rules: set
Updates the positions of the path-selection rules.
PUT http://{device}/api/sh.appflow/2.0/path_rules{?is_default,apptag_id,site_id,app_id,uplink_id}
Request Body
Provide a path_rules data object.
Response BodyReturns a path_rules data object.
path_rules: clear
Deletes all the path-selection rule instances.
POST http://{device}/api/sh.appflow/2.0/path_rules/clear
Request Body
Do not provide a request body.
Response BodyOn success, the server does not provide any body in the responses.
Resource: path_rule
Path-Selection Rule Object
http://{device}/api/sh.appflow/2.0/path_rules/items/{id}
{ "id": identifier, "site_id": multiple, "site_name": string, "sitetag_id": multiple, "app_id": multiple, "app_name": string, "apptag_id": multiple, "apptag_name": string, "uplinks": [ { "uplink_id": multiple, "uplink_dscp": multiple, <prop>: any } ], "default_action_id": integer, "is_default": boolean, "position": integer }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| path_rule | <object> | Path-Selection Rule Object | |
| path_rule.id | <identifier> | Generic numeric identifier | Read-only; |
| path_rule.site_id | <multiple> | Site ID. Either Site ID or SiteTag ID can be specified, but not both. | Optional; |
| path_rule.site_id.anyOf[0] | <integer> | ||
| path_rule.site_id.anyOf[1] | <null> | ||
| site_name | <string> | Site Name | Read-only; Pattern: '^(\S.*)?\S$'; |
| path_rule.sitetag_id | <multiple> | SiteTag ID. Either Site ID or SiteTag ID can be specified, but not both. | Optional; |
| path_rule.sitetag_id.anyOf[0] | <integer> | ||
| path_rule.sitetag_id.anyOf[1] | <null> | ||
| path_rule.app_id | <multiple> | Application ID. Either Application ID or ApplicationTag ID can be specified, but not both. | Optional; |
| path_rule.app_id.anyOf[0] | <application_identifier> | Application numeric identifier | |
| path_rule.app_id.anyOf[1] | <null> | ||
| app_name | <string> | Application Name | Read-only; Pattern: '^(\S.*)?\S$'; |
| path_rule.apptag_id | <multiple> | ApplicationTag ID. Either Application ID or ApplicationTag ID can be specified, but not both. | Optional; |
| path_rule.apptag_id.anyOf[0] | <integer> | ||
| path_rule.apptag_id.anyOf[1] | <null> | ||
| apptag_name | <string> | ApplicationTag Name | Read-only; Pattern: '^(\S.*)?\S$'; |
| path_rule.uplinks | <array of <object>> | Uplinks specified for the rule | Optional; |
| path_rule.uplinks[items] | <object> | ||
| path_rule.uplinks[items].uplink_id | <multiple> | Optional; | |
| path_rule.uplinks[items].uplink_id.anyOf [0] |
<integer> | ||
| path_rule.uplinks[items].uplink_id.anyOf [1] |
<null> | ||
| path_rule.uplinks[items].uplink_dscp | <multiple> | Optional; | |
| path_rule.uplinks[items].uplink_dscp. anyOf[0] |
<dscp_ps_rule> | For extended DSCP fields. Used for the DSCP passed to the data-path. It assumes values from 0 to 63 and values to trigger some extra actions on DSCP: * 255 to `preserve` the DSCP from innner to outer channel and the other way around. | |
| path_rule.uplinks[items].uplink_dscp. anyOf[1] |
<null> | ||
| path_rule.uplinks[items].<prop> | <any> | Optional; | |
| path_rule.default_action_id | <integer> | Optional; | |
| path_rule.is_default | <boolean> | Is the path-selection rule a default rule? | Read-only; Optional; |
| path_rule.position | <integer> | Position of the path-selection rule | Read-only; Optional; |
Links
path_rule: get
GET http://{device}/api/sh.appflow/2.0/path_rules/items/{id}
Response Body
Returns a path_rule data object.
path_rule: set
PUT http://{device}/api/sh.appflow/2.0/path_rules/items/{id}
Request Body
Provide a path_rule data object.
Response BodyReturns a path_rule data object.
path_rule: delete
DELETE http://{device}/api/sh.appflow/2.0/path_rules/items/{id}
Response Body
On success, the server does not provide any body in the responses.
Relations
path_rule: uplink_1
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/uplinks/0/uplink_id |
path_rule: uplink_2
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/uplinks/1/uplink_id |
path_rule: uplink_3
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/uplinks/2/uplink_id |
path_rule: default_action
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/default_action_id |
Resource: default_actions
Collection for Path Selection Default Actions [RELAY | DROP]
http://{device}/api/sh.appflow/2.0/default_actions
[ default_action ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| default_actions | <array of <default_action>> | Collection for Path Selection Default Actions [RELAY | DROP] | |
| default_actions[items] | <default_action> | Path Selection Default Action [RELAY | DROP] |
Links
default_actions: get
GET http://{device}/api/sh.appflow/2.0/default_actions
Response Body
Returns a default_actions data object.
Resource: default_action
Path Selection Default Action [RELAY | DROP]
http://{device}/api/sh.appflow/2.0/default_actions/items/{id}
{ "id": identifier, "name": string }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| default_action | <object> | Path Selection Default Action [RELAY | DROP] | Required properties: [name]; |
| default_action.id | <identifier> | Generic numeric identifier | Read-only; |
| default_action.name | <string> |
Links
default_action: get
GET http://{device}/api/sh.appflow/2.0/default_actions/items/{id}
Response Body
Returns a default_action data object.
Resource: qos_rules
List of QoS Rules
http://{device}/api/sh.appflow/2.0/qos_rules{?is_default,apptag_id,qos_profile_id,app_id}
[ { "id": identifier, "app_name": string, "class_name": string, "dscp": multiple, "position": integer, "is_default": boolean } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| qos_rules | <array of <object>> | List of QoS Rules | |
| qos_rules[items] | <object> | Required properties: [id, position]; | |
| qos_rules[items].id | <identifier> | Generic numeric identifier | Read-only; |
| app_name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| class_name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| dscp | <multiple> | For extended DSCP fields. Used for the DSCP passed to the data-path. It assumes values from 0 to 63 and values to trigger some extra actions on DSCP: * 255 to `preserve` the DSCP from innner to outer channel and the other way around. | Read-only; |
| dscp.anyOf[0] | <dscp_mark> | For 6-bit DSCP fields. Used to match the DSCP of packets coming from the wire, and for path-selection probes DSCP. | |
| dscp.anyOf[1] | <dscp_qos_special> | Special values for QoS DSCP behavior | |
| qos_rules[items].position | <integer> | ||
| qos_rules[items].is_default | <boolean> | Read-only; Optional; |
Links
qos_rules: create
POST http://{device}/api/sh.appflow/2.0/qos_rules{?is_default,apptag_id,qos_profile_id,app_id}
Request Body
Provide a qos_rule data object.
Response BodyReturns a qos_rule data object.
qos_rules: get
GET http://{device}/api/sh.appflow/2.0/qos_rules{?is_default,apptag_id,qos_profile_id,app_id}
Response Body
Returns a qos_rules data object.
qos_rules: set
Deletes all QoS rules that are default.
PUT http://{device}/api/sh.appflow/2.0/qos_rules{?is_default,apptag_id,qos_profile_id,app_id}
Request Body
Provide an empty_collection data object.
Response BodyOn success, the server does not provide any body in the responses.
Resource: qos_rule
Quality of Service (QoS) Rule Object
http://{device}/api/sh.appflow/2.0/qos_rules/items/{id}
{ "id": identifier, "qos_profile_id": integer, "app_id": multiple, "app_name": string, "apptag_id": multiple, "apptag_name": string, "dscp": multiple, "class_id": multiple, "class_name": string, "is_default": boolean, "position": integer }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| qos_rule | <object> | Quality of Service (QoS) Rule Object | |
| qos_rule.id | <identifier> | Generic numeric identifier | Read-only; |
| qos_rule.qos_profile_id | <integer> | ID of associated class set | Optional; |
| qos_rule.app_id | <multiple> | Application ID. Either Application ID or ApplicationTag ID can be specified, but not both. | Optional; |
| qos_rule.app_id.anyOf[0] | <application_identifier> | Application numeric identifier | |
| qos_rule.app_id.anyOf[1] | <null> | ||
| app_name | <string> | Application Name | Read-only; Pattern: '^(\S.*)?\S$'; |
| qos_rule.apptag_id | <multiple> | ApplicationTag ID. Either Application ID or ApplicationTag ID can be specified, but not both. | Optional; |
| qos_rule.apptag_id.anyOf[0] | <integer> | ||
| qos_rule.apptag_id.anyOf[1] | <null> | ||
| apptag_name | <string> | ApplicationTag Name | Read-only; Pattern: '^(\S.*)?\S$'; |
| dscp | <multiple> | DSCP value to be set for QoS marking. | |
| dscp.anyOf[0] | <dscp_mark> | For 6-bit DSCP fields. Used to match the DSCP of packets coming from the wire, and for path-selection probes DSCP. | |
| dscp.anyOf[1] | <dscp_qos_special> | Special values for QoS DSCP behavior | |
| qos_rule.class_id | <multiple> | Class ID for shaping purposes. | Optional; |
| qos_rule.class_id.anyOf[0] | <integer> | ||
| qos_rule.class_id.anyOf[1] | <null> | ||
| class_name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| qos_rule.is_default | <boolean> | Is the QoS rule a default rule? | Read-only; Optional; |
| qos_rule.position | <integer> | Position of the QoS rule in its profile. | Read-only; Optional; |
Links
qos_rule: get
GET http://{device}/api/sh.appflow/2.0/qos_rules/items/{id}
Response Body
Returns a qos_rule data object.
qos_rule: set
PUT http://{device}/api/sh.appflow/2.0/qos_rules/items/{id}
Request Body
Provide a qos_rule data object.
Response BodyReturns a qos_rule data object.
qos_rule: delete
DELETE http://{device}/api/sh.appflow/2.0/qos_rules/items/{id}
Response Body
On success, the server does not provide any body in the responses.
Relations
qos_rule: qos_profile
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/qos_profile_id |
qos_rule: class
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/class_id |
Resource: groups
List of Application Groups. Group is one of the required properties of an Application. Each Group represents one of the most common Path-Selection offload scenarios. This is a static list that cannot be modified.
http://{device}/api/sh.appflow/2.0/groups{?name}
[ { "id": integer, "name": string, "description": string } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| groups | <array of <object>> | List of Application Groups. Group is one of the required properties of an Application. Each Group represents one of the most common Path-Selection offload scenarios. This is a static list that cannot be modified. | |
| groups[items] | <object> | Read-only; | |
| id | <integer> | Generic numeric identifier | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| groups[items].description | <string> | Read-only; Optional; |
Links
groups: get
GET http://{device}/api/sh.appflow/2.0/groups{?name}
Response Body
Returns a groups data object.
Resource: l4protocols
List of Layer 4 Protocols. This is a static list that cannot be modified.
http://{device}/api/sh.appflow/2.0/l4protocols{?name}
[ { "name": string, "number": integer } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| l4protocols | <array of <object>> | List of Layer 4 Protocols. This is a static list that cannot be modified. | |
| l4protocols[items] | <object> | Read-only; | |
| name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| l4protocols[items].number | <integer> | Layer 4 protocol number | Read-only; Optional; |
Links
l4protocols: get
GET http://{device}/api/sh.appflow/2.0/l4protocols{?name}
Response Body
Returns a l4protocols data object.
Resource: l7protocol
Layer 7 Protocol
http://{device}/api/sh.appflow/2.0/l7protocols/items/{id}
{ "id": integer, "name": string, "description": string, "metadata_keys": [ string ], "priority_fields": [ { "name": string, "priority": integer } ] }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| l7protocol | <object> | Layer 7 Protocol | |
| id | <integer> | Generic numeric identifier | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| l7protocol.description | <string> | Read-only; Optional; | |
| l7protocol.metadata_keys | <array of <string>> | List of keys associated with this Layer 7 protocol | Read-only; Optional; |
| l7protocol.metadata_keys[items] | <string> | Name of a metadata key associated with this Layer 7 protocol | Read-only; |
| l7protocol.priority_fields | <array of <object>> | List of priority fields associated with this Layer 7 protocol. Tuples of (priority value, priority name). | Optional; |
| l7protocol.priority_fields[items] | <object> | Read-only; | |
| name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| l7protocol.priority_fields[items]. priority |
<integer> | Read-only; Optional; |
Links
l7protocol: get
GET http://{device}/api/sh.appflow/2.0/l7protocols/items/{id}
Response Body
Returns a l7protocol data object.
Relations
Resource: l7protocols
A snapshot of all the Layer 7 protocols in the system. This is a static list that cannot be modified. To get the full details of a particular Layer 7 protocol use the 'l7protocol' resource.
http://{device}/api/sh.appflow/2.0/l7protocols{?name}
[ { "id": integer, "name": string, "description": string } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| l7protocols | <array of <object>> | A snapshot of all the Layer 7 protocols in the system. This is a static list that cannot be modified. To get the full details of a particular Layer 7 protocol use the 'l7protocol' resource. | |
| l7protocols[items] | <object> | Read-only; | |
| id | <integer> | Generic numeric identifier | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| l7protocols[items].description | <string> | Read-only; Optional; |
Links
l7protocols: get
GET http://{device}/api/sh.appflow/2.0/l7protocols{?name}
Response Body
Returns a l7protocols data object.
Resource: apptag
Tag for an Application
http://{device}/api/sh.appflow/2.0/app_tags/items/{id}
{ "id": identifier, "name": unrestricted_name, "is_built_in": boolean, "applications": [ { "id": identifier, "name": string } ] }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| apptag | <object> | Tag for an Application | Required properties: [name]; |
| apptag.id | <identifier> | Generic numeric identifier | Read-only; |
| apptag.name | <unrestricted_name> | Generic name field, all characters allowed except for leading and trailing whitespace | Pattern: '^(\S.*)?\S$'; |
| apptag.is_built_in | <boolean> | Flag that specifies whether this tag is built_in and cannot be deleted. True indicates that it is built_in and cannot be deleted, False indicates that it is not built_in and can be deleted. | Read-only; Optional; |
| apptag.applications | <array of <object>> | Array of applications that have this tag associated with them. Array of tuples of (Application ID, Application Name) | Optional; |
| apptag.applications[items] | <object> | ||
| apptag.applications[items].id | <identifier> | Generic numeric identifier | Read-only; |
| name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
Links
apptag: get
GET http://{device}/api/sh.appflow/2.0/app_tags/items/{id}
Response Body
Returns an apptag data object.
Relations
Resource: application
Definition of a QoS Application
http://{device}/api/sh.appflow/2.0/applications/items/{id}
{ "id": application_identifier, "name": unrestricted_name, "description": multiple, "traffic_type_id": multiple, "traffic_type_name": multiple, "l4_protocol_id": multiple, "l4_protocol_name": multiple, "dscp": multiple, "vlan": multiple, "local_port": multiple, "local_portlabel": multiple, "remote_port": multiple, "remote_portlabel": multiple, "local_net": multiple, "local_hostlabel": multiple, "remote_net": multiple, "remote_hostlabel": multiple, "l7_protocol_id": multiple, "l7_protocol_name": multiple, "l7_protocol_params": [ { "name": string, "value": string } ], "tags": [ { "is_built_in": boolean, "id": integer, "name": string } ], "group_id": integer, "group_name": string, "business_criticality_id": integer, "business_criticality_name": string, "category_id": integer, "category_name": string, "is_built_in": boolean }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| application | <object> | Definition of a QoS Application | Required properties: [business_criticality_id, category_id, group_id, name]; |
| application.id | <application_identifier> | Application numeric identifier | |
| application.name | <unrestricted_name> | Generic name field, all characters allowed except for leading and trailing whitespace | Pattern: '^(\S.*)?\S$'; |
| application.description | <multiple> | Description of the Application | Optional; |
| application.description.anyOf[0] | <string> | ||
| application.description.anyOf[1] | <null> | ||
| application.traffic_type_id | <multiple> | ID of the traffic type that this Application applies to. A value of 'null' catches both Optimized and Passthrough traffic. | Optional; |
| application.traffic_type_id.anyOf[0] | <integer> | ||
| application.traffic_type_id.anyOf[1] | <null> | ||
| application.traffic_type_name | <multiple> | Traffic type (Optimized, Passthrough or both) that this application applies to. | Read-only; Optional; |
| application.traffic_type_name.anyOf[0] | <name> | Generic name field, only alphanumeric '-' and '_' allowed | Pattern: '^[a-zA-Z0-9_-]+$'; |
| application.traffic_type_name.anyOf[1] | <null> | Read-only; | |
| application.l4_protocol_id | <multiple> | ID of Layer 4 protocol of traffic that this Application applies to. Foreign Key into the Layer 4 protocols table. | Optional; |
| application.l4_protocol_id.anyOf[0] | <integer> | ||
| application.l4_protocol_id.anyOf[1] | <null> | ||
| application.l4_protocol_name | <multiple> | Name of Layer 4 protocol of traffic that this Application applies to. | Read-only; Optional; |
| application.l4_protocol_name.anyOf[0] | <unrestricted_name> | Generic name field, all characters allowed except for leading and trailing whitespace | Pattern: '^(\S.*)?\S$'; |
| application.l4_protocol_name.anyOf[1] | <null> | Read-only; | |
| application.dscp | <multiple> | DSCP of traffic that this Application applies to. A value of 'null' here catches all DSCP values. | Optional; |
| application.dscp.anyOf[0] | <dscp_mark> | For 6-bit DSCP fields. Used to match the DSCP of packets coming from the wire, and for path-selection probes DSCP. | |
| application.dscp.anyOf[1] | <null> | ||
| application.vlan | <multiple> | VLAN of traffic that this Application applies to. A value of 'null' here catches all VLANs. | Optional; |
| application.vlan.anyOf[0] | <vlan> | Type for VLAN field in the Ethernet header | |
| application.vlan.anyOf[1] | <null> | ||
| application.local_port | <multiple> | Local port of traffic that this Application applies to. Only one of local_port and local_portlabel can be specified. | Optional; |
| application.local_port.anyOf[0] | <integer> | Range: 1 to 65535; | |
| application.local_port.anyOf[1] | <null> | ||
| application.local_portlabel | <multiple> | Name of Port Label, an alternate way of specifying the local ports of traffic that this Application applies to. Only one of local_port and local_portlabel can be specified. | Optional; |
| application.local_portlabel.anyOf[0] | <string> | ||
| application.local_portlabel.anyOf[1] | <null> | ||
| application.remote_port | <multiple> | Remote port of traffic that this Application applies to. Only one of remote_port and remote_portlabel can be specified. | Optional; |
| application.remote_port.anyOf[0] | <integer> | Range: 1 to 65535; | |
| application.remote_port.anyOf[1] | <null> | ||
| application.remote_portlabel | <multiple> | Name of Port Label, an alternate way of specifying the remote ports of traffic that thisApplication applies to. Only one of remote_port and remote_portlabel can be specified. | Optional; |
| application.remote_portlabel.anyOf[0] | <string> | ||
| application.remote_portlabel.anyOf[1] | <null> | ||
| application.local_net | <multiple> | Local subnet of traffic that this Application applies to. Only one of local_net and local_hostlabel can be specified. | Optional; |
| application.local_net.anyOf[0] | <ipv4prefix> | IPv4 prefix (x.y.z.k/mask) | Pattern: '^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(/(3[012]|[12]?[0-9]))$'; |
| application.local_net.anyOf[1] | <null> | ||
| application.local_hostlabel | <multiple> | Name of Host Label, an alternate way of specifying the local IP addresses of traffic that this Application applies to. Only one of local_net and local_hostlabel can be specified. | Optional; |
| application.local_hostlabel.anyOf[0] | <string> | ||
| application.local_hostlabel.anyOf[1] | <null> | ||
| application.remote_net | <multiple> | Remote subnet of traffic that this Application applies to. Only one of remote_net and remote_hostlabel can be specified. | Optional; |
| application.remote_net.anyOf[0] | <ipv4prefix> | IPv4 prefix (x.y.z.k/mask) | Pattern: '^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(/(3[012]|[12]?[0-9]))$'; |
| application.remote_net.anyOf[1] | <null> | ||
| application.remote_hostlabel | <multiple> | Name of Host Label, an alternate way of specifying the remote IP addresses of traffic that this Application applies to. Only one of remote_net and remote_hostlabel can be specified. | Optional; |
| application.remote_hostlabel.anyOf[0] | <string> | ||
| application.remote_hostlabel.anyOf[1] | <null> | ||
| application.l7_protocol_id | <multiple> | ID of Layer 7 protocol of traffic that this Application applies to. Foreign Key into the Layer 7 protocols table | Optional; |
| application.l7_protocol_id.anyOf[0] | <integer> | ||
| application.l7_protocol_id.anyOf[1] | <null> | ||
| application.l7_protocol_name | <multiple> | Name of Layer 7 protocol of traffic that this Application applies to. | Read-only; Optional; |
| application.l7_protocol_name.anyOf[0] | <unrestricted_name> | Generic name field, all characters allowed except for leading and trailing whitespace | Pattern: '^(\S.*)?\S$'; |
| application.l7_protocol_name.anyOf[1] | <null> | Read-only; | |
| application.l7_protocol_params | <array of <object>> | List of parameters specific to the Layer 7 protocol of this Application | Optional; |
| application.l7_protocol_params[items] | <object> | ||
| application.l7_protocol_params[items]. name |
<string> | Name of the Layer 7 protocol-metadata field | Optional; |
| application.l7_protocol_params[items]. value |
<string> | Value of the Layer 7 protocol-metadata field | Optional; |
| tags | <array of <object>> | A snapshot of all the Application Tags in the system. For full details of a particular Application Tag use the 'apptag' resource. An Application Tag cannot be modified through this resource. To modify an Application Tag use the 'apptag' resource instead. | Read-only; |
| tags[items] | <object> | Read-only; | |
| tags[items].is_built_in | <boolean> | Flag that specifies whether this tag is built_in and cannot be deleted. True indicates that it is built_in and cannot be deleted, False indicates that it is not built_in and can be deleted. | Read-only; Optional; |
| id | <integer> | Generic numeric identifier | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| application.group_id | <integer> | ||
| group_name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| business_criticality_id | <integer> | ID of the Business Criticality property of this Application. Foreign Key into the Business_criticalities resource. | Read-only; Range: 1 to 18446744073709551615; |
| business_criticality_name | <string> | Name of the Business Criticality property of this Application. Represents the Application's business importance. | Read-only; Pattern: '^(\S.*)?\S$'; |
| category_id | <integer> | ID of the Category property of this Application. Foreign Key into the Categories resource. | Read-only; Range: 1 to 18446744073709551615; |
| category_name | <string> | Name of the Category property of this Application. Represents the general function of this Application. | Read-only; Pattern: '^(\S.*)?\S$'; |
| application.is_built_in | <boolean> | Specifies whether the Application is built_in | Read-only; Optional; |
| application.allOf[0] | <multiple> | ||
| application.allOf[0].not | <object> | Required properties: [local_port, local_portlabel]; | |
| application.allOf[0].not.local_port | <integer> | ||
| application.allOf[0].not.local_portlabel | <string> | ||
| application.allOf[0].not.<prop> | <any> | Optional; | |
| application.allOf[1] | <multiple> | ||
| application.allOf[1].not | <object> | Required properties: [remote_port, remote_portlabel]; | |
| application.allOf[1].not.remote_port | <integer> | ||
| application.allOf[1].not. remote_portlabel |
<string> | ||
| application.allOf[1].not.<prop> | <any> | Optional; | |
| application.allOf[2] | <multiple> | ||
| application.allOf[2].not | <object> | Required properties: [local_net, local_hostlabel]; | |
| application.allOf[2].not.local_net | <ipv4prefix> | IPv4 prefix (x.y.z.k/mask) | Pattern: '^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(/(3[012]|[12]?[0-9]))$'; |
| application.allOf[2].not.local_hostlabel | <string> | ||
| application.allOf[2].not.<prop> | <any> | Optional; | |
| application.allOf[3] | <multiple> | ||
| application.allOf[3].not | <object> | Required properties: [remote_net, remote_hostlabel]; | |
| application.allOf[3].not.remote_net | <ipv4prefix> | IPv4 prefix (x.y.z.k/mask) | Pattern: '^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(/(3[012]|[12]?[0-9]))$'; |
| application.allOf[3].not. remote_hostlabel |
<string> | ||
| application.allOf[3].not.<prop> | <any> | Optional; |
Links
application: get
GET http://{device}/api/sh.appflow/2.0/applications/items/{id}
Response Body
Returns an application data object.
application: set
PUT http://{device}/api/sh.appflow/2.0/applications/items/{id}
Request Body
Provide an application data object.
Response BodyReturns an application data object.
application: delete
DELETE http://{device}/api/sh.appflow/2.0/applications/items/{id}
Response Body
On success, the server does not provide any body in the responses.
Relations
Resource: applications
A snapshot of all the Applications in the system. To get the full details of a particular Application use the 'application' resource. An Application cannot be modified through this resource. To modify an Application use the 'application' resource.
http://{device}/api/sh.appflow/2.0/applications{?uses_portlabel,category_id,name,uses_hostlabel,is_built_in,group_id,business_criticality_id}
[ { "business_criticality_name": string, "category_name": string, "id": integer, "name": string, "tags": [ { "is_built_in": boolean, "id": integer, "name": string } ], "description": string, "group_name": string, "is_built_in": boolean } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| applications | <array of <object>> | A snapshot of all the Applications in the system. To get the full details of a particular Application use the 'application' resource. An Application cannot be modified through this resource. To modify an Application use the 'application' resource. | |
| applications[items] | <object> | Read-only; | |
| business_criticality_name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| category_name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| id | <integer> | Application numeric identifier | Read-only; Range: 1 to 65535; |
| name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| tags | <array of <object>> | A snapshot of all the Application Tags in the system. For full details of a particular Application Tag use the 'apptag' resource. An Application Tag cannot be modified through this resource. To modify an Application Tag use the 'apptag' resource instead. | Read-only; |
| tags[items] | <object> | Read-only; | |
| tags[items].is_built_in | <boolean> | Flag that specifies whether this tag is built_in and cannot be deleted. True indicates that it is built_in and cannot be deleted, False indicates that it is not built_in and can be deleted. | Read-only; Optional; |
| id | <integer> | Generic numeric identifier | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| applications[items].description | <string> | Read-only; Optional; | |
| group_name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Read-only; Pattern: '^(\S.*)?\S$'; |
| applications[items].is_built_in | <boolean> | Specifies whether the application is built_in. | Read-only; Optional; |
Links
applications: get
GET http://{device}/api/sh.appflow/2.0/applications{?uses_portlabel,category_id,name,uses_hostlabel,is_built_in,group_id,business_criticality_id}
Response Body
Returns an applications data object.
applications: create
POST http://{device}/api/sh.appflow/2.0/applications{?uses_portlabel,category_id,name,uses_hostlabel,is_built_in,group_id,business_criticality_id}
Request Body
Provide an application data object.
Response BodyReturns an application data object.
applications: set
PUT http://{device}/api/sh.appflow/2.0/applications{?uses_portlabel,category_id,name,uses_hostlabel,is_built_in,group_id,business_criticality_id}
Request Body
Provide an empty_collection data object.
Response BodyOn success, the server does not provide any body in the responses.
applications: reset
Resets the list of applications back to the factory default.
POST http://{device}/api/sh.appflow/2.0/applications/reset
Request Body
Do not provide a request body.
Response BodyOn success, the server does not provide any body in the responses.
applications: dump
Get the list of applications with the full details of each application specified.
GET http://{device}/api/sh.appflow/2.0/applications/dump
Response Body
On success, the server returns a response body with the following structure:
[ application ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| applications.links.dump.response | <array of <application>> | ||
| applications.links.dump.response[items] | <application> | Definition of a QoS Application |
Resource: class
QoS Class
http://{device}/api/sh.appflow/2.0/classes/items/{id}
{ "id": integer, "qos_profile_id": number, "name": string, "parent_id": number, "is_leaf": boolean, "is_default_class": boolean }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| class | <object> | QoS Class | Required properties: [name, qos_profile_id, parent_id]; |
| id | <integer> | Class ID | Read-only; Range: 1 to 18446744073709551615; |
| class.qos_profile_id | <number> | Reference to the QoS Profile | |
| name | <string> | Class Name | Pattern: '^(\S.*)?\S$'; |
| class.parent_id | <number> | Reference to the Parent Class ID | |
| class.is_leaf | <boolean> | Is this class a leaf class or inner class? | Read-only; Optional; |
| class.is_default_class | <boolean> | Is this class the default class in the QoS Profile? | Read-only; Optional; |
Links
class: get
GET http://{device}/api/sh.appflow/2.0/classes/items/{id}
Response Body
Returns a class data object.
class: set
PUT http://{device}/api/sh.appflow/2.0/classes/items/{id}
Request Body
Provide a class data object.
Response BodyReturns a class data object.
class: delete
DELETE http://{device}/api/sh.appflow/2.0/classes/items/{id}
Response Body
On success, the server does not provide any body in the responses.
Relations
class: qos_profile
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/qos_profile_id |
Resource: classes
List of QoS Class IDs and names
http://{device}/api/sh.appflow/2.0/classes{?is_leaf,name,qos_profile_id}
[ class ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| classes | <array of <class>> | List of QoS Class IDs and names | |
| classes[items] | <class> | QoS Class |
Links
classes: set
Delete all the Class instances (except for default root class in default class set).
PUT http://{device}/api/sh.appflow/2.0/classes{?is_leaf,name,qos_profile_id}
Request Body
Provide an empty_collection data object.
Response BodyOn success, the server does not provide any body in the responses.
classes: get
GET http://{device}/api/sh.appflow/2.0/classes{?is_leaf,name,qos_profile_id}
Response Body
Returns a classes data object.
Resource: queue_type
QoS Queue
http://{device}/api/sh.appflow/2.0/queue_types/items/{id}
{ "id": integer, "name": string }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| queue_type | <object> | QoS Queue | Required properties: [name]; |
| id | <integer> | Queue Type ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Queue Type Name | Pattern: '^[a-zA-Z0-9_-]+$'; |
Links
queue_type: get
GET http://{device}/api/sh.appflow/2.0/queue_types/items/{id}
Response Body
Returns a queue_type data object.
Relations
Resource: queue_types
List of QoS Queues
http://{device}/api/sh.appflow/2.0/queue_types{?name}
[ { "id": integer, "name": string, "shaper_name": string } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| queue_types | <array of <object>> | List of QoS Queues | |
| queue_types[items] | <object> | ||
| id | <integer> | Queue Type ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Queue Type Name | Pattern: '^[a-zA-Z0-9_-]+$'; |
| shaper_name | <string> | Qdisc in Shaper | Pattern: '^[a-zA-Z0-9_-]+$'; |
Links
queue_types: get
GET http://{device}/api/sh.appflow/2.0/queue_types{?name}
Response Body
Returns a queue_types data object.
Resource: qos_profile
QoS Profile
http://{device}/api/sh.appflow/2.0/qos_profiles/items/{id}
{ "id": integer, "name": string, "classes_tree": { "id": integer, "name": string, "is_default_class": boolean, "children": [ classes_tree ] }, "is_default": boolean }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| qos_profile | <object> | QoS Profile | Required properties: [name]; |
| id | <integer> | QoS Profile ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | QoS Profile Name | Pattern: '^(\S.*)?\S$'; |
| classes_tree | <object> | Class hierarchy tree type | Read-only; |
| id | <integer> | Class ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Class Name | Pattern: '^(\S.*)?\S$'; |
| classes_tree.is_default_class | <boolean> | Is this class the default class in the tree? | Read-only; Optional; |
| classes_tree.children | <array of <classes_tree>> | Read-only; Optional; | |
| classes_tree.children[items] | <classes_tree> | Class hierarchy tree type | |
| qos_profile.is_default | <boolean> | Is this default QoS Profile ? | Read-only; Optional; |
Links
qos_profile: get
GET http://{device}/api/sh.appflow/2.0/qos_profiles/items/{id}
Response Body
Returns a qos_profile data object.
qos_profile: set
PUT http://{device}/api/sh.appflow/2.0/qos_profiles/items/{id}
Request Body
Provide a qos_profile data object.
Response BodyReturns a qos_profile data object.
qos_profile: delete
DELETE http://{device}/api/sh.appflow/2.0/qos_profiles/items/{id}
Response Body
On success, the server does not provide any body in the responses.
Relations
qos_profile: full
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/id |
Resource: qos_profiles
List of QoS Profile IDs and names
http://{device}/api/sh.appflow/2.0/qos_profiles{?is_default,name}
[ { "id": integer, "name": string, "is_default": boolean } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| qos_profiles | <array of <object>> | List of QoS Profile IDs and names | |
| qos_profiles[items] | <object> | ||
| id | <integer> | QoS Profile ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | QoS Profile Name | Pattern: '^(\S.*)?\S$'; |
| qos_profiles[items].is_default | <boolean> | Is this default QoS Profile ? | Read-only; Optional; |
Links
qos_profiles: get
GET http://{device}/api/sh.appflow/2.0/qos_profiles{?is_default,name}
Response Body
Returns a qos_profiles data object.
qos_profiles: set
Delete all the QoS Profile instances (except for default class set)
PUT http://{device}/api/sh.appflow/2.0/qos_profiles{?is_default,name}
Request Body
Provide an empty_collection data object.
Response BodyOn success, the server does not provide any body in the responses.
qos_profiles: create
POST http://{device}/api/sh.appflow/2.0/qos_profiles{?is_default,name}
Request Body
Provide a qos_profile data object.
Response BodyReturns a qos_profile data object.
qos_profiles: reset
Resets the QoS Default-Profile back to factory-default.
POST http://{device}/api/sh.appflow/2.0/qos_profiles/reset
Request Body
Do not provide a request body.
Response BodyOn success, the server does not provide any body in the responses.
Resource: uplink_variation
Uplink Variation
http://{device}/api/sh.appflow/2.0/uplink_variations/items/{id}
{ "id": integer, "name": string, "uplink_id": multiple, "qos_profile_id": number, "class_params": [ { "class_id": number, "ob_queue_type_id": number, "ob_queue_length": number, "ib_queue_length": number, "min_bw": number, "max_bw": number, "ls_weight": number, "dscp": multiple, "priority": number, "connection_limit": number, "ib_flow_padding_enable": boolean, "ib_flow_padding_override": boolean, "ib_flow_padding_timeout": number, "ib_tcp_control_enable": boolean, "ib_tcp_control_override": boolean, "ib_tcp_control_fssdetect": number, "ib_tcp_control_idledetect": number, "ib_tcp_control_weight": number } ] }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| uplink_variation | <object> | Uplink Variation | Required properties: [name, qos_profile_id, uplink_id, class_params]; |
| id | <integer> | Uplink Variation ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Uplink Variation Name | Pattern: '^(\S.*)?\S$'; |
| uplink_variation.uplink_id | <multiple> | Reference to the Uplink | |
| uplink_variation.uplink_id.anyOf[0] | <identifier> | Generic numeric identifier | Read-only; |
| uplink_variation.uplink_id.anyOf[1] | <null> | ||
| uplink_variation.qos_profile_id | <number> | Reference to QoS Profile ID | |
| uplink_variation.class_params | <array of <object>> | List of all QoS Class Parameters associated to this Uplink Variation | |
| uplink_variation.class_params[items] | <object> | QoS Class Params | Required properties: [class_id]; |
| uplink_variation.class_params[items]. class_id |
<number> | Reference to the QoS Class | |
| uplink_variation.class_params[items]. ob_queue_type_id |
<number> | Reference to the Queue Type of an Outbound Class | Optional; |
| uplink_variation.class_params[items]. ob_queue_length |
<number> | Length of the Outbound QoS Queue | Optional; |
| uplink_variation.class_params[items]. ib_queue_length |
<number> | Length of the Inbound QoS Queue | Optional; |
| min_bw | <number> | Minimum Bandwidth | Range: 0 to 100; |
| max_bw | <number> | Maximum Bandwidth | Range: 0 to 100; |
| ls_weight | <number> | HFSC link share weight | Range: 0 to 100; |
| dscp | <multiple> | Default DSCP | |
| dscp.anyOf[0] | <dscp_mark> | For 6-bit DSCP fields. Used to match the DSCP of packets coming from the wire, and for path-selection probes DSCP. | |
| dscp.anyOf[1] | <dscp_class_special> | Special values for class DSCP behavior | |
| uplink_variation.class_params[items]. priority |
<number> | Latency Priority | Optional; Range: 1 to 6; |
| uplink_variation.class_params[items]. connection_limit |
<number> | Maximum number of connections | Optional; |
| uplink_variation.class_params[items]. ib_flow_padding_enable |
<boolean> | Enable/disable inbound QoS Flow Padding feature, default is enabled. | Optional; |
| uplink_variation.class_params[items]. ib_flow_padding_override |
<boolean> | Whether or not to override the global Inbound QoS Flow Padding configuration. | Optional; |
| ib_flow_padding_timeout | <number> | Timeout for Deque/Link-Sharing Phantoms as a percentage fraction of average TCP round-trip time. | Range: 0 to 100; |
| uplink_variation.class_params[items]. ib_tcp_control_enable |
<boolean> | Enable/disable inbound QoS TCP Control feature, default is enabled. | Optional; |
| uplink_variation.class_params[items]. ib_tcp_control_override |
<boolean> | Whether or not to override the global Inbound QoS TCP Control configuration. | Optional; |
| ib_tcp_control_fssdetect | <number> | False slow start detection settings | Range: 0 to 100; |
| ib_tcp_control_idledetect | <number> | TCP idle restart detection settings | Range: 0 to 100; |
| ib_tcp_control_weight | <number> | TCP Slow-Start phantom weight as a percentage fraction of the real packet | Range: 0 to 100; |
Links
uplink_variation: get
GET http://{device}/api/sh.appflow/2.0/uplink_variations/items/{id}
Response Body
Returns an uplink_variation data object.
uplink_variation: set
PUT http://{device}/api/sh.appflow/2.0/uplink_variations/items/{id}
Request Body
Provide an uplink_variation data object.
Response BodyReturns an uplink_variation data object.
uplink_variation: delete
DELETE http://{device}/api/sh.appflow/2.0/uplink_variations/items/{id}
Response Body
On success, the server does not provide any body in the responses.
Relations
uplink_variation: qos_profile
Related resource Variables| Related var | Data value for replacement |
|---|---|
| id | 0/qos_profile_id |
Resource: uplink_variations
List of Uplink Variations
http://{device}/api/sh.appflow/2.0/uplink_variations{?uplink_id,name,qos_profile_id}
[ { "id": integer, "name": string } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| uplink_variations | <array of <object>> | List of Uplink Variations | |
| uplink_variations[items] | <object> | ||
| id | <integer> | Uplink Variation ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Uplink Variation Name | Pattern: '^(\S.*)?\S$'; |
Links
uplink_variations: get
GET http://{device}/api/sh.appflow/2.0/uplink_variations{?uplink_id,name,qos_profile_id}
Response Body
Returns an uplink_variations data object.
uplink_variations: set
PUT http://{device}/api/sh.appflow/2.0/uplink_variations{?uplink_id,name,qos_profile_id}
Request Body
Provide an empty_collection data object.
Response BodyOn success, the server does not provide any body in the responses.
Resource: path
Site Uplink Combination
http://{device}/api/sh.appflow/2.0/paths/items/{site_id}/{uplink_id}
{ "site_id": number, "uplink_id": number, "estimated_ob_bw": number, "estimated_ib_bw": number, "configured_ob_bw": number, "configured_ib_bw": number }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| path | <object> | Site Uplink Combination | |
| path.site_id | <number> | Reference to the Site | Optional; |
| path.uplink_id | <number> | Reference to the Uplink | Optional; |
| path.estimated_ob_bw | <number> | Estimated outbound bottleneck bandwidth of the site (site_id) over the uplink (uplink_id) | Read-only; Optional; |
| path.estimated_ib_bw | <number> | Estimated inbound bottleneck bandwidth of the site (site_id) over the uplink (uplink_id) | Read-only; Optional; |
| path.configured_ob_bw | <number> | Configured outbound bottleneck bandwidth of the site (site_id) over the uplink (uplink_id) | Optional; |
| path.configured_ib_bw | <number> | Configured inbound bottleneck bandwidth of the site (site_id) over the uplink (uplink_id) | Optional; |
Links
path: get
GET http://{device}/api/sh.appflow/2.0/paths/items/{site_id}/{uplink_id}
Response Body
Returns a path data object.
path: set
PUT http://{device}/api/sh.appflow/2.0/paths/items/{site_id}/{uplink_id}
Request Body
Provide a path data object.
Response BodyReturns a path data object.
Relations
Resource: paths
List of Path (Site Uplink Combinations)
http://{device}/api/sh.appflow/2.0/paths{?uplink_id,site_id}
[ { "site_id": number, "uplink_id": number, "estimated_ob_bw": number, "estimated_ib_bw": number, "configured_ob_bw": number, "configured_ib_bw": number } ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| paths | <array of <items>> | List of Path (Site Uplink Combinations) | |
| items | <object> | Site Uplink Combination | |
| items.site_id | <number> | Reference to the Site | Optional; |
| items.uplink_id | <number> | Reference to the Uplink | Optional; |
| items.estimated_ob_bw | <number> | Estimated outbound bottleneck bandwidth of the site (site_id) over the uplink (uplink_id) | Read-only; Optional; |
| items.estimated_ib_bw | <number> | Estimated inbound bottleneck bandwidth of the site (site_id) over the uplink (uplink_id) | Read-only; Optional; |
| items.configured_ob_bw | <number> | Configured outbound bottleneck bandwidth of the site (site_id) over the uplink (uplink_id) | Optional; |
| items.configured_ib_bw | <number> | Configured inbound bottleneck bandwidth of the site (site_id) over the uplink (uplink_id) | Optional; |
Links
paths: get
GET http://{device}/api/sh.appflow/2.0/paths{?uplink_id,site_id}
Response Body
Returns a paths data object.
Resource: shaper_id
QoS Class ID in Shaper (Linux Kernel)
http://{device}/api/sh.appflow/2.0/shaper_ids/items/{class_shaper_id}
{ "site_id": integer, "site_name": string, "class_id": integer, "class_name": string, "direction": number, "class_shaper_id": number }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| shaper_id | <object> | QoS Class ID in Shaper (Linux Kernel) | Required properties: [site_id, class_id, class_shaper_id]; |
| site_id | <integer> | Reference to the Site. | Read-only; Range: 1 to 18446744073709551615; |
| site_name | <string> | Site name | Pattern: '^(\S.*)?\S$'; |
| class_id | <integer> | Reference to the Class. | Read-only; Range: 1 to 18446744073709551615; |
| class_name | <string> | Class name | Pattern: '^(\S.*)?\S$'; |
| shaper_id.direction | <number> | Outbound - 0, Inbound - 1 | Optional; Range: 0 to 1; |
| shaper_id.class_shaper_id | <number> | QoS class ID in shaper (minor ID of a TC class) | Range: 1 to 65535; |
Links
shaper_id: get
Get the data representation of a class shaper ID.
GET http://{device}/api/sh.appflow/2.0/shaper_ids/items/{class_shaper_id}
Response Body
Returns a shaper_id data object.
Relations
shaper_id: full
Related resource Variables| Related var | Data value for replacement |
|---|---|
| class_shaper_id | 0/class_shaper_id |
Resource: shaper_ids
List of QoS Class Shaper IDs
http://{device}/api/sh.appflow/2.0/shaper_ids{?class_id,direction,class_shaper_id,site_id}
[ shaper_id ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| shaper_ids | <array of <shaper_id>> | List of QoS Class Shaper IDs | |
| shaper_ids[items] | <shaper_id> | QoS Class ID in Shaper (Linux Kernel) |
Links
shaper_ids: get
GET http://{device}/api/sh.appflow/2.0/shaper_ids{?class_id,direction,class_shaper_id,site_id}
Response Body
Returns a shaper_ids data object.
Resource: global_configs
Global Configuration Collection
http://{device}/api/sh.appflow/2.0/global_configs{?group,name,value}
[ global_config ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| global_configs | <array of <global_config>> | Global Configuration Collection | |
| global_configs[items] | <global_config> | Global Configuration Item |
Links
global_configs: get
GET http://{device}/api/sh.appflow/2.0/global_configs{?group,name,value}
Response Body
Returns a global_configs data object.
Resource: global_config
Global Configuration Item
http://{device}/api/sh.appflow/2.0/global_configs/items/{group}/{name}
| Property Name | Type | Description | Notes |
|---|---|---|---|
| global_config | <object> | Global Configuration Item | Required properties: [group, name, value]; |
| global_config.group | <name> | Generic name field, only alphanumeric '-' and '_' allowed | Pattern: '^[a-zA-Z0-9_-]+$'; |
| global_config.name | <name> | Generic name field, only alphanumeric '-' and '_' allowed | Pattern: '^[a-zA-Z0-9_-]+$'; |
| global_config.value | <string> |
Links
global_config: get
GET http://{device}/api/sh.appflow/2.0/global_configs/items/{group}/{name}
Response Body
Returns a global_config data object.
global_config: set
PUT http://{device}/api/sh.appflow/2.0/global_configs/items/{group}/{name}
Request Body
Provide a global_config data object.
Response BodyReturns a global_config data object.
Relations
global_config: full
Related resource Variables| Related var | Data value for replacement |
|---|---|
| group | 0/group |
| name | 0/name |
Resource: path_stats
Read-Only Resource for Path-Selection Statistics
http://{device}/api/sh.appflow/2.0/path_stats{?area_id,uplink_id,remote_site_id,peer_ip}
{ "local_site_id": identifier, "local_site_name": unrestricted_name, "uplinks": [ { "uplink_id": identifier, "uplink_name": unrestricted_name, "uplink_status": uplink_status, "remote_sites": [ { "remote_site_id": identifier, "remote_site_name": unrestricted_name, "areas": [ { "area_id": identifier, "bytes_sent": integer, "peers_availability": [ { "peer_ip": ipv4address, "status": peer_availability, "public_ip": ipv4address, "port": integer } ] } ] } ] } ] }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| path_stats | <object> | Read-Only Resource for Path-Selection Statistics | |
| path_stats.local_site_id | <identifier> | Generic numeric identifier | Read-only; |
| path_stats.local_site_name | <unrestricted_name> | Generic name field, all characters allowed except for leading and trailing whitespace | Pattern: '^(\S.*)?\S$'; |
| path_stats.uplinks | <array of <object>> | Optional; | |
| path_stats.uplinks[items] | <object> | ||
| path_stats.uplinks[items].uplink_id | <identifier> | Generic numeric identifier | Read-only; |
| path_stats.uplinks[items].uplink_name | <unrestricted_name> | Generic name field, all characters allowed except for leading and trailing whitespace | Pattern: '^(\S.*)?\S$'; |
| path_stats.uplinks[items].uplink_status | <uplink_status> | Uplink status based on remote peers availability * healthy - all the remote peer are `up` or `never` * warning - some of the remote peers are `down` * critical - all of the remote peers are `down` or `never` | Values: healthy, warning, critical; |
| path_stats.uplinks[items].remote_sites | <array of <object>> | Optional; | |
| path_stats.uplinks[items].remote_sites [items] |
<object> | ||
| path_stats.uplinks[items].remote_sites [items].remote_site_id |
<identifier> | Generic numeric identifier | Read-only; |
| path_stats.uplinks[items].remote_sites [items].remote_site_name |
<unrestricted_name> | Generic name field, all characters allowed except for leading and trailing whitespace | Pattern: '^(\S.*)?\S$'; |
| path_stats.uplinks[items].remote_sites [items].areas |
<array of <object>> | Optional; | |
| path_stats.uplinks[items].remote_sites [items].areas[items] |
<object> | ||
| path_stats.uplinks[items].remote_sites [items].areas[items].area_id |
<identifier> | Generic numeric identifier | Read-only; |
| path_stats.uplinks[items].remote_sites [items].areas[items].bytes_sent |
<integer> | Optional; | |
| path_stats.uplinks[items].remote_sites [items].areas[items]. peers_availability |
<array of <object>> | Optional; | |
| path_stats.uplinks[items].remote_sites [items].areas[items]. peers_availability[items] |
<object> | ||
| path_stats.uplinks[items].remote_sites [items].areas[items]. peers_availability[items].peer_ip |
<ipv4address> | IPv4 address (x.y.z.k) | Pattern: '^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'; |
| path_stats.uplinks[items].remote_sites [items].areas[items]. peers_availability[items].status |
<peer_availability> | Remote peer availability * up - responding to pings * down - Used to be up, now not responding * never - Never responded * unknown - Never tried to ping | Values: down, up, never, unknown; |
| path_stats.uplinks[items].remote_sites [items].areas[items]. peers_availability[items].public_ip |
<ipv4address> | IPv4 address (x.y.z.k) | Pattern: '^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'; |
| path_stats.uplinks[items].remote_sites [items].areas[items]. peers_availability[items].port |
<integer> | Optional; |
Links
path_stats: get
GET http://{device}/api/sh.appflow/2.0/path_stats{?area_id,uplink_id,remote_site_id,peer_ip}
Response Body
Returns a path_stats data object.
Resource: migration_errors
List of Errors Encountered During Migration
http://{device}/api/sh.appflow/2.0/migration_errors
[ string ]
| Property Name | Type | Description | Notes |
|---|---|---|---|
| migration_errors | <array of <string>> | List of Errors Encountered During Migration | |
| migration_errors[items] | <string> | Read-only; |
Links
migration_errors: get
GET http://{device}/api/sh.appflow/2.0/migration_errors
Response Body
Returns a migration_errors data object.
migration_errors: set
PUT http://{device}/api/sh.appflow/2.0/migration_errors
Request Body
Provide an empty_collection data object.
Response BodyOn success, the server does not provide any body in the responses.
Type: identifier
Generic numeric identifier
integer
| Property Name | Type | Description | Notes |
|---|---|---|---|
| identifier | <integer> | Generic numeric identifier | Read-only; Range: 1 to 18446744073709551615; |
Type: application_identifier
Application numeric identifier
integer
| Property Name | Type | Description | Notes |
|---|---|---|---|
| application_identifier | <integer> | Application numeric identifier | Range: 1 to 65535; |
Type: empty_collection
Empty collection used to partially clear a collection
multiple
| Property Name | Type | Description | Notes |
|---|---|---|---|
| empty_collection | <multiple> | Empty collection used to partially clear a collection | |
| empty_collection.anyOf[0] | <array of <null>> | Maximum: 0 items; | |
| empty_collection.anyOf[0][items] | <null> | ||
| empty_collection.anyOf[1] | <array of <string>> | 1-1 items; | |
| empty_collection.anyOf[1][items] | <string> |
Type: name
Generic name field, only alphanumeric '-' and '_' allowed
string
| Property Name | Type | Description | Notes |
|---|---|---|---|
| name | <string> | Generic name field, only alphanumeric '-' and '_' allowed | Pattern: '^[a-zA-Z0-9_-]+$'; |
Type: unrestricted_name
Generic name field, all characters allowed except for leading and trailing whitespace
string
| Property Name | Type | Description | Notes |
|---|---|---|---|
| unrestricted_name | <string> | Generic name field, all characters allowed except for leading and trailing whitespace | Pattern: '^(\S.*)?\S$'; |
Type: percentage
Percentage type
number
| Property Name | Type | Description | Notes |
|---|---|---|---|
| percentage | <number> | Percentage type | Range: 0 to 100; |
Type: dscp_mark
For 6-bit DSCP fields. Used to match the DSCP of packets coming from the wire, and for path-selection probes DSCP.
integer
| Property Name | Type | Description | Notes |
|---|---|---|---|
| dscp_mark | <integer> | For 6-bit DSCP fields. Used to match the DSCP of packets coming from the wire, and for path-selection probes DSCP. | Range: 0 to 63; |
Type: dscp_ps_special
Special values for path-selection DSCP behavior
integer
| Property Name | Type | Description | Notes |
|---|---|---|---|
| dscp_ps_special | <integer> | Special values for path-selection DSCP behavior | Range: 255 to 255; |
Type: dscp_class_special
Special values for class DSCP behavior
integer
| Property Name | Type | Description | Notes |
|---|---|---|---|
| dscp_class_special | <integer> | Special values for class DSCP behavior | Range: 255 to 255; |
Type: dscp_qos_special
Special values for QoS DSCP behavior
integer
| Property Name | Type | Description | Notes |
|---|---|---|---|
| dscp_qos_special | <integer> | Special values for QoS DSCP behavior | Range: 254 to 255; |
Type: dscp_ps_rule
For extended DSCP fields. Used for the DSCP passed to the data-path. It assumes values from 0 to 63 and values to trigger some extra actions on DSCP: * 255 to `preserve` the DSCP from innner to outer channel and the other way around.
multiple
| Property Name | Type | Description | Notes |
|---|---|---|---|
| dscp_ps_rule | <multiple> | For extended DSCP fields. Used for the DSCP passed to the data-path. It assumes values from 0 to 63 and values to trigger some extra actions on DSCP: * 255 to `preserve` the DSCP from innner to outer channel and the other way around. | |
| dscp_ps_rule.anyOf[0] | <dscp_mark> | For 6-bit DSCP fields. Used to match the DSCP of packets coming from the wire, and for path-selection probes DSCP. | |
| dscp_ps_rule.anyOf[1] | <dscp_ps_special> | Special values for path-selection DSCP behavior |
Type: dscp_qos_rule
For extended DSCP fields. Used for the DSCP passed to the data-path. It assumes values from 0 to 63 and values to trigger some extra actions on DSCP: * 255 to `preserve` the DSCP from innner to outer channel and the other way around.
multiple
| Property Name | Type | Description | Notes |
|---|---|---|---|
| dscp_qos_rule | <multiple> | For extended DSCP fields. Used for the DSCP passed to the data-path. It assumes values from 0 to 63 and values to trigger some extra actions on DSCP: * 255 to `preserve` the DSCP from innner to outer channel and the other way around. | |
| dscp_qos_rule.anyOf[0] | <dscp_mark> | For 6-bit DSCP fields. Used to match the DSCP of packets coming from the wire, and for path-selection probes DSCP. | |
| dscp_qos_rule.anyOf[1] | <dscp_qos_special> | Special values for QoS DSCP behavior |
Type: dscp_class
For extended DSCP fields. Used for the DSCP passed to the data-path. It assumes values from 0 to 63 and values to trigger some extra actions on DSCP: * 255 to `preserve` the DSCP from innner to outer channel and the other way around.
multiple
| Property Name | Type | Description | Notes |
|---|---|---|---|
| dscp_class | <multiple> | For extended DSCP fields. Used for the DSCP passed to the data-path. It assumes values from 0 to 63 and values to trigger some extra actions on DSCP: * 255 to `preserve` the DSCP from innner to outer channel and the other way around. | |
| dscp_class.anyOf[0] | <dscp_mark> | For 6-bit DSCP fields. Used to match the DSCP of packets coming from the wire, and for path-selection probes DSCP. | |
| dscp_class.anyOf[1] | <dscp_class_special> | Special values for class DSCP behavior |
Type: ipv4address
IPv4 address (x.y.z.k)
string
| Property Name | Type | Description | Notes |
|---|---|---|---|
| ipv4address | <string> | IPv4 address (x.y.z.k) | Pattern: '^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$'; |
Type: ipv4prefix
IPv4 prefix (x.y.z.k/mask)
string
| Property Name | Type | Description | Notes |
|---|---|---|---|
| ipv4prefix | <string> | IPv4 prefix (x.y.z.k/mask) | Pattern: '^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(/(3[012]|[12]?[0-9]))$'; |
Type: vlan
Type for VLAN field in the Ethernet header
integer
| Property Name | Type | Description | Notes |
|---|---|---|---|
| vlan | <integer> | Type for VLAN field in the Ethernet header | Range: 0 to 4094; |
Type: peer_availability
Remote peer availability * up - responding to pings * down - Used to be up, now not responding * never - Never responded * unknown - Never tried to ping
string
| Property Name | Type | Description | Notes |
|---|---|---|---|
| peer_availability | <string> | Remote peer availability * up - responding to pings * down - Used to be up, now not responding * never - Never responded * unknown - Never tried to ping | Values: down, up, never, unknown; |
Type: uplink_status
Uplink status based on remote peers availability * healthy - all the remote peer are `up` or `never` * warning - some of the remote peers are `down` * critical - all of the remote peers are `down` or `never`
string
| Property Name | Type | Description | Notes |
|---|---|---|---|
| uplink_status | <string> | Uplink status based on remote peers availability * healthy - all the remote peer are `up` or `never` * warning - some of the remote peers are `down` * critical - all of the remote peers are `down` or `never` | Values: healthy, warning, critical; |
Type: classes_tree
Class hierarchy tree type
{ "id": integer, "name": string, "is_default_class": boolean, "children": [ classes_tree ] }
| Property Name | Type | Description | Notes |
|---|---|---|---|
| classes_tree | <object> | Class hierarchy tree type | |
| id | <integer> | Class ID | Read-only; Range: 1 to 18446744073709551615; |
| name | <string> | Class Name | Pattern: '^(\S.*)?\S$'; |
| classes_tree.is_default_class | <boolean> | Is this class the default class in the tree? | Optional; |
| classes_tree.children | <array of <classes_tree>> | Optional; | |
| classes_tree.children[items] | <classes_tree> | Class hierarchy tree type |