NPM Classification APIs v3.1
Created Dec 18, 2020 at 07:09 PM

Resource: application

This resource deals with general application

http://{device}/api/npm.classification/3.1/applications/items/{id}
  • JSON
  • {
      "created": string,
      "definitions": {
        "items": [ app_definition_3_0 ],
        <prop>: any
      },
      "desc": string,
      "enabled": boolean,
      "id": number,
      "last_modified": string,
      "last_modified_username": string,
      "name": string,
      "priority": integer,
      "traffic_match_mode": string
    }
    Property Name Type Description Notes
    application <object> This resource deals with general application Required properties: [name];
    application.created <string> Time (seconds from epoch) at which the rule was first created Optional;
    application.definitions <object> Optional;
    application.definitions.items <array of <app_definition_3_0>> Optional;
    application.definitions.items[items] <app_definition_3_0>
    application.definitions.<prop> <any> Optional;
    application.desc <string> Describes the General Application Definition Optional;
    application.enabled <boolean> Status of this General Application Definition - enabled/disabled Optional;
    application.id <number> Unique ID generated by the backend for this General Application Definition Optional;
    application.last_modified <string> Time (seconds from epoch) at which the rule was last modified Optional;
    application.last_modified_username <string> The last user to modify this rule Optional;
    application.name <string> Unique case sensitive name of General Application Definition
    application.priority <integer> Application priority used in case the traffic can be associated only with a single application, lower the value the higher the priority Optional;
    application.traffic_match_mode <string> mode to configure traffic match Optional; Values: HIGH, MEDIUM, LOW;

    Resource: applications

    This resource deals with collection of general applications

    http://{device}/api/npm.classification/3.1/applications
  • JSON
  • {
      "items": [ application ]
    }
    Property Name Type Description Notes
    applications <object> This resource deals with collection of general applications
    applications.items <array of <application>> Optional;
    applications.items[items] <application> This resource deals with general application

    Resource: hostgroup

    This resource deals with Host Group

    http://{device}/api/npm.classification/3.1/hostgroups/items/{id}
  • JSON
  • {
      "created": string,
      "desc": string,
      "enabled": boolean,
      "hosts": host_list,
      "id": number,
      "in_speed": number,
      "in_speed_unit": speed_unit,
      "last_modified": string,
      "last_modified_username": string,
      "member_hostgroups": id_list,
      "member_hostgroups_names": [
        string
      ],
      "name": string,
      "out_speed": number,
      "out_speed_unit": speed_unit,
      <prop>: any
    }
    Property Name Type Description Notes
    hostgroup <object> This resource deals with Host Group
    hostgroup.created <string> Time (seconds from epoch) at which the Host Group was first created Optional;
    hostgroup.desc <string> Description of Host Group Optional;
    hostgroup.enabled <boolean> Status of the Host Group - enabled/disabled Optional;
    hostgroup.hosts <host_list> List of hosts(e.g. x.x.x.x, x.x.x.x/prefix), host-ranges(e.g. x.x.x.x-y.y.y.y, x.x.x.x/prefix-y.y.y.y/prefix)
    hostgroup.id <number> Unique ID assigned by the backend Read-only; Optional;
    hostgroup.in_speed <number> Inbound Utilization Optional;
    hostgroup.in_speed_unit <speed_unit> Unit of Network Traffic Speed Values: kbps, Mbps, Gbps;
    hostgroup.last_modified <string> Time (seconds from epoch) at which the Host Group was last modified Optional;
    hostgroup.last_modified_username <string> The last user to modify this rule Optional;
    hostgroup.member_hostgroups <id_list> List of IDs
    hostgroup.member_hostgroups_names <array of <string>> List of Host Group names Optional;
    hostgroup.member_hostgroups_names[items] <string>
    hostgroup.name <string> Unique name of Host Group Optional;
    hostgroup.out_speed <number> Outbound Utilization Optional;
    hostgroup.out_speed_unit <speed_unit> Unit of Network Traffic Speed Values: kbps, Mbps, Gbps;
    hostgroup.<prop> <any> Optional;

    Resource: hostgroups

    This resource deals with Host Groups

    http://{device}/api/npm.classification/3.1/hostgroups
  • JSON
  • {
      "items": [ hostgroup ],
      <prop>: any
    }
    Property Name Type Description Notes
    hostgroups <object> This resource deals with Host Groups
    hostgroups.items <array of <hostgroup>> Optional;
    hostgroups.items[items] <hostgroup> This resource deals with Host Group
    hostgroups.<prop> <any> Optional;

    Resource: url

    This resource deals with url application

    http://{device}/api/npm.classification/3.1/urls/items/{id}
  • JSON
  • {
      "created": string,
      "desc": string,
      "enabled": boolean,
      "id": number,
      "last_modified": string,
      "last_modified_username": string,
      "name": string,
      "preferred": boolean,
      "urls": [
        string
      ]
    }
    Property Name Type Description Notes
    url <object> This resource deals with url application Required properties: [name, urls];
    url.created <string> Time (seconds from epoch) at which the rule was first created Optional;
    url.desc <string> Optional;
    url.enabled <boolean> Optional;
    url.id <number> Optional;
    url.last_modified <string> Time (seconds from epoch) at which the rule was last modified Optional;
    url.last_modified_username <string> The last user to modify this rule Optional;
    url.name <string>
    url.preferred <boolean> Optional;
    url.urls <array of <string>>
    url.urls[items] <string>

    Resource: urls

    This resource deals with collection of url applications

    http://{device}/api/npm.classification/3.1/urls
  • JSON
  • {
      "items": [ url ]
    }
    Property Name Type Description Notes
    urls <object> This resource deals with collection of url applications
    urls.items <array of <url>> Optional;
    urls.items[items] <url> This resource deals with url application

    Type: app_definition_3_0

  • JSON
  • {
      "dpi_ids": [
        integer
      ],
      "hostgroup_ids": id_list,
      "hosts": host_list,
      "transport_rules": [
        {
          "ip_protocol": string,
          "ports": string
        }
      ],
      <prop>: any
    }
    Property Name Type Description Notes
    app_definition_3_0 <object>
    app_definition_3_0.dpi_ids <array of <integer>> Optional;
    app_definition_3_0.dpi_ids[items] <integer>
    app_definition_3_0.hostgroup_ids <id_list> List of IDs
    app_definition_3_0.hosts <host_list> List of hosts(e.g. x.x.x.x, x.x.x.x/prefix), host-ranges(e.g. x.x.x.x-y.y.y.y, x.x.x.x/prefix-y.y.y.y/prefix)
    app_definition_3_0.transport_rules <array of <object>> List of port ranges Optional;
    app_definition_3_0.transport_rules
    [items]
    <object> IP Protocol and transport ports Required properties: [ip_protocol];
    app_definition_3_0.transport_rules
    [items].ip_protocol
    <string> IP protocol identifier. Full list can be retrieved with /ip_protocols resource
    app_definition_3_0.transport_rules
    [items].ports
    <string> comma seperated list of port ranges. e.g. x, p-q, y-z Optional;
    app_definition_3_0.<prop> <any> Optional;

    Type: bulk_deleter

    Object to trigger bulk deletion of given resource

  • JSON
  • {
      "delete_all": boolean,
      "delete_ids": id_list,
      <prop>: any
    }
    Property Name Type Description Notes
    bulk_deleter <object> Object to trigger bulk deletion of given resource
    bulk_deleter.delete_all <boolean> Delete all objects of the given resource Optional;
    bulk_deleter.delete_ids <id_list> List of IDs
    bulk_deleter.<prop> <any> Optional;

    Type: host_list

    List of hosts(e.g. x.x.x.x, x.x.x.x/prefix), host-ranges(e.g. x.x.x.x-y.y.y.y, x.x.x.x/prefix-y.y.y.y/prefix)

  • JSON
  • [
      string
    ]
    Property Name Type Description Notes
    host_list <array of <string>> List of hosts(e.g. x.x.x.x, x.x.x.x/prefix), host-ranges(e.g. x.x.x.x-y.y.y.y, x.x.x.x/prefix-y.y.y.y/prefix)
    host_list[items] <string>

    Type: id_list

    List of IDs

  • JSON
  • [
      number
    ]
    Property Name Type Description Notes
    id_list <array of <number>> List of IDs
    id_list[items] <number>

    Type: speed_unit

    Unit of Network Traffic Speed

  • JSON
  • string
    Property Name Type Description Notes
    speed_unit <string> Unit of Network Traffic Speed Values: kbps, Mbps, Gbps;