REST API for the AppFlow service. Includes Applications, Profiles, Rules, Topology v2.0
Created Dec 18, 2020 at 07:16 PM

Resource: reset

Reset all appflow configuration back to the factory default

http://{device}/api/sh.appflow/2.0/reset
  • JSON
  • null
    Property Name Type Description Notes
    reset <null> Reset all appflow configuration back to the factory default

    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
  • JSON
  • {
      "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;

    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}
  • JSON
  • [
      {
        "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$';

    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}
  • JSON
  • [
      {
        "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_-]+$';

    Resource: traffic_types

    List of Traffic Types

    http://{device}/api/sh.appflow/2.0/traffic_types{?name}
  • JSON
  • [
      {
        "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_-]+$';

    Resource: securitylevels

    List of Security Levels

    http://{device}/api/sh.appflow/2.0/securitylevels{?name}
  • JSON
  • [
      {
        "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_-]+$';

    Resource: networks

    List of Networks

    http://{device}/api/sh.appflow/2.0/networks{?is_default,parent_id,name,virtual}
  • JSON
  • [ network ]
    Property Name Type Description Notes
    networks <array of <network>> List of Networks
    networks[items] <network> Network object

    Resource: network

    Network object

    http://{device}/api/sh.appflow/2.0/networks/items/{id}
  • JSON
  • {
      "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;

    Relations

    network: instances

    Related resource

    networks

    network: parent

    Related resource

    network

    Variables
    Related var Data value for replacement
    id 0/parent_id

    network: child

    Related resource

    networks

    Variables
    Related var Data value for replacement
    parent_id 0/id

    network: seclevel

    Related resource

    securitylevels

    Variables
    Related var Data value for replacement
    id 0/seclevel_id

    network: full

    Related resource

    network

    Variables
    Related var Data value for replacement
    id 0/id

    Resource: sitetags

    List of Site Tags

    http://{device}/api/sh.appflow/2.0/sitetags{?is_built_in,name}
  • JSON
  • [ sitetag ]
    Property Name Type Description Notes
    sitetags <array of <sitetag>> List of Site Tags
    sitetags[items] <sitetag> A Site Tag Resource

    Resource: sitetag

    A Site Tag Resource

    http://{device}/api/sh.appflow/2.0/sitetags/items/{id}
  • JSON
  • {
      "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_-]+$';

    Relations

    sitetag: instances

    Related resource

    sitetags

    sitetag: full

    Related resource

    sitetag

    Variables
    Related var Data value for replacement
    id 0/id

    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}
  • JSON
  • [ site ]
    Property Name Type Description Notes
    sites <array of <site>> List of Sites
    sites[items] <site> Site object

    Resource: site

    Site object

    http://{device}/api/sh.appflow/2.0/sites/items/{id}
  • JSON
  • {
      "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;

    Relations

    site: instances

    Related resource

    sites

    site: areas

    Related resource

    areas

    Variables
    Related var Data value for replacement
    site_id 0/id

    site: ob_qos_profile

    Related resource

    qos_profile

    Variables
    Related var Data value for replacement
    id 0/ob_qos_profile_id

    site: ib_qos_profile

    Related resource

    qos_profile

    Variables
    Related var Data value for replacement
    id 0/ib_qos_profile_id

    site: full

    Related resource

    site

    Variables
    Related var Data value for replacement
    id 0/id

    Resource: areas

    List of Areas

    http://{device}/api/sh.appflow/2.0/areas{?display_id,is_default,site_id}
  • JSON
  • [ area ]
    Property Name Type Description Notes
    areas <array of <area>> List of Areas
    areas[items] <area> Area Object, i.e., subnets rechability for peers.

    Resource: area

    Area Object, i.e., subnets rechability for peers.

    http://{device}/api/sh.appflow/2.0/areas/items/{id}{?is_default}
  • JSON
  • {
      "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]))$';

    Relations

    area: site

    Related resource

    site

    Variables
    Related var Data value for replacement
    id 0/site_id

    area: full

    Related resource

    area

    Variables
    Related var Data value for replacement
    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}
  • JSON
  • [
      {
        "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>

    Resource: path_rule

    Path-Selection Rule Object

    http://{device}/api/sh.appflow/2.0/path_rules/items/{id}
  • JSON
  • {
      "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;

    Relations

    path_rule: instances

    Related resource

    path_rules

    path_rule: default_action

    Related resource

    default_action

    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
    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]

    Resource: default_action

    Path Selection Default Action [RELAY | DROP]

    http://{device}/api/sh.appflow/2.0/default_actions/items/{id}
  • JSON
  • {
      "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>

    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}
  • JSON
  • [
      {
        "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;

    Resource: qos_rule

    Quality of Service (QoS) Rule Object

    http://{device}/api/sh.appflow/2.0/qos_rules/items/{id}
  • JSON
  • {
      "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;

    Relations

    qos_rule: instances

    Related resource

    qos_rules

    qos_rule: qos_profile

    Related resource

    qos_profile

    Variables
    Related var Data value for replacement
    id 0/qos_profile_id

    qos_rule: class

    Related resource

    class

    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}
  • JSON
  • [
      {
        "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;

    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}
  • JSON
  • [
      {
        "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;

    Resource: l7protocol

    Layer 7 Protocol

    http://{device}/api/sh.appflow/2.0/l7protocols/items/{id}
  • JSON
  • {
      "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;

    Relations

    l7protocol: instances

    Related resource

    l7protocols

    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}
  • JSON
  • [
      {
        "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;

    Resource: apptag

    Tag for an Application

    http://{device}/api/sh.appflow/2.0/app_tags/items/{id}
  • JSON
  • {
      "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$';

    Relations

    apptag: instances

    Related resource

    apptags

    Resource: apptags

    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.

    http://{device}/api/sh.appflow/2.0/app_tags{?name}
  • JSON
  • [
      {
        "is_built_in": boolean,
        "id": integer,
        "name": string
      }
    ]
    Property Name Type Description Notes
    apptags <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.
    apptags[items] <object> Read-only;
    apptags[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$';

    Resource: application

    Definition of a QoS Application

    http://{device}/api/sh.appflow/2.0/applications/items/{id}
  • JSON
  • {
      "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;

    Relations

    application: instances

    Related resource

    applications

    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}
  • JSON
  • [
      {
        "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;

    Resource: class

    QoS Class

    http://{device}/api/sh.appflow/2.0/classes/items/{id}
  • JSON
  • {
      "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;

    Relations

    class: instances

    Related resource

    classes

    class: qos_profile

    Related resource

    qos_profile

    Variables
    Related var Data value for replacement
    id 0/qos_profile_id

    class: parent

    Related resource

    class

    Variables
    Related var Data value for replacement
    id 0/parent_id

    class: full

    Related resource

    class

    Variables
    Related var Data value for replacement
    id 0/id

    Resource: classes

    List of QoS Class IDs and names

    http://{device}/api/sh.appflow/2.0/classes{?is_leaf,name,qos_profile_id}
  • JSON
  • [ class ]
    Property Name Type Description Notes
    classes <array of <class>> List of QoS Class IDs and names
    classes[items] <class> QoS Class

    Resource: queue_type

    QoS Queue

    http://{device}/api/sh.appflow/2.0/queue_types/items/{id}
  • JSON
  • {
      "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_-]+$';

    Relations

    queue_type: instances

    Related resource

    queue_types

    Resource: queue_types

    List of QoS Queues

    http://{device}/api/sh.appflow/2.0/queue_types{?name}
  • JSON
  • [
      {
        "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_-]+$';

    Resource: qos_profile

    QoS Profile

    http://{device}/api/sh.appflow/2.0/qos_profiles/items/{id}
  • JSON
  • {
      "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;

    Relations

    qos_profile: instances

    Related resource

    qos_profiles

    qos_profile: full

    Related resource

    qos_profile

    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}
  • JSON
  • [
      {
        "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;

    Resource: path

    Site Uplink Combination

    http://{device}/api/sh.appflow/2.0/paths/items/{site_id}/{uplink_id}
  • JSON
  • {
      "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;

    Relations

    path: instances

    Related resource

    paths

    path: site

    Related resource

    site

    Variables
    Related var Data value for replacement
    id 0/site_id

    Resource: paths

    List of Path (Site Uplink Combinations)

    http://{device}/api/sh.appflow/2.0/paths{?uplink_id,site_id}
  • JSON
  • [
      {
        "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;

    Resource: shaper_id

    QoS Class ID in Shaper (Linux Kernel)

    http://{device}/api/sh.appflow/2.0/shaper_ids/items/{class_shaper_id}
  • JSON
  • {
      "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;

    Relations

    shaper_id: instances

    Related resource

    shaper_ids

    shaper_id: full

    Related resource

    shaper_id

    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}
  • JSON
  • [ 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)

    Resource: global_configs

    Global Configuration Collection

    http://{device}/api/sh.appflow/2.0/global_configs{?group,name,value}
    Property Name Type Description Notes
    global_configs <array of <global_config>> Global Configuration Collection
    global_configs[items] <global_config> Global Configuration Item

    Resource: global_config

    Global Configuration Item

    http://{device}/api/sh.appflow/2.0/global_configs/items/{group}/{name}
  • JSON
  • {
      "group": name,
      "name": name,
      "value": string
    }
    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>

    Relations

    global_config: full

    Related resource

    global_config

    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}
  • JSON
  • {
      "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;

    Resource: migration_errors

    List of Errors Encountered During Migration

    http://{device}/api/sh.appflow/2.0/migration_errors
  • JSON
  • [
      string
    ]
    Property Name Type Description Notes
    migration_errors <array of <string>> List of Errors Encountered During Migration
    migration_errors[items] <string> Read-only;

    Type: identifier

    Generic numeric identifier

  • JSON
  • integer
    Property Name Type Description Notes
    identifier <integer> Generic numeric identifier Read-only; Range: 1 to 18446744073709551615;

    Type: application_identifier

    Application numeric identifier

  • JSON
  • 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

  • JSON
  • 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

  • JSON
  • 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

  • JSON
  • 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

  • JSON
  • 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.

  • JSON
  • 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

  • JSON
  • 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

  • JSON
  • 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

  • JSON
  • 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.

  • JSON
  • 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.

  • JSON
  • 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.

  • JSON
  • 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)

  • JSON
  • 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)

  • JSON
  • 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

  • JSON
  • 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

  • JSON
  • 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: classes_tree

    Class hierarchy tree type

  • JSON
  • {
      "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