apis » npm.packet_analysis » 2.3
NPM Packet Analysis APIs v2.3
Created Nov 12, 2024 at 09:56 PM

Resource: app_mapper

Application traffic filters rule.

http://{device}/api/npm.packet_analysis/2.3/app_mappers/items/{name}
  • JSON
    • {
  "definitions": app_mapper_definition_list,
  "enabled": boolean,
  "name": string,
  <prop>: any
}
    Property Name Type Description Notes
    app_mapper <object> Application traffic filters rule. Required properties: [name, enabled];
    app_mapper.definitions <app_mapper_definition_list> List of Application Traffic Filters definitions.
    app_mapper.enabled <boolean> Enable/disable the rule.
    app_mapper.name <string> Unique application rule name.
    app_mapper.<prop> <any> Optional;

    app_mapper: get

    Returns the application traffic filters rule.

    GET http://{device}/api/npm.packet_analysis/2.3/app_mappers/items/{name}
    Response Body

    Returns an app_mapper data object.

    app_mapper: set

    Updates the application traffic filters rule.

    PUT http://{device}/api/npm.packet_analysis/2.3/app_mappers/items/{name}
    Request Body

    Provide an app_mapper data object.

    Response Body

    Returns an app_mapper data object.

    Resource: app_mappers

    Application traffic filters rules.

    http://{device}/api/npm.packet_analysis/2.3/app_mappers
  • JSON
    • {
  "items": [ app_mapper ],
  <prop>: any
}
    Property Name Type Description Notes
    app_mappers <object> Application traffic filters rules.
    app_mappers.items <array of <app_mapper>> Optional;
    app_mappers.items[items] <app_mapper> Application traffic filters rule.
    app_mappers.<prop> <any> Optional;

    app_mappers: get

    Returns the list of application traffic filters rules used in 'packets' datasource.

    GET http://{device}/api/npm.packet_analysis/2.3/app_mappers
    Response Body

    Returns an app_mappers data object.

    Resource: dba_protocol

    DBA Module protocols filter.

    http://{device}/api/npm.packet_analysis/2.3/dba_protocols/items/{name}
  • JSON
    • {
  "definitions": app_mapper_definition_list,
  "enabled": boolean,
  "name": string,
  <prop>: any
}
    Property Name Type Description Notes
    dba_protocol <object> DBA Module protocols filter. Required properties: [name, enabled];
    dba_protocol.definitions <app_mapper_definition_list> List of Application Traffic Filters definitions.
    dba_protocol.enabled <boolean> Enable/disable the rule.
    dba_protocol.name <string> DBA Module protocol rule name. Values: MYSQL, SQLSERVER, ORACLE, DB2, INFORMIX, SYBASE_ASE, TERADATA, POSTGRESQL;
    dba_protocol.<prop> <any> Optional;

    dba_protocol: get

    Returns the DBA Module traffic filters rule.

    GET http://{device}/api/npm.packet_analysis/2.3/dba_protocols/items/{name}
    Response Body

    Returns a dba_protocol data object.

    dba_protocol: set

    Updates the DBA Module traffic filters rule.

    PUT http://{device}/api/npm.packet_analysis/2.3/dba_protocols/items/{name}
    Request Body

    Provide a dba_protocol data object.

    Response Body

    Returns a dba_protocol data object.

    Resource: dba_protocols

    DBA Module protocols filters.

    http://{device}/api/npm.packet_analysis/2.3/dba_protocols
  • JSON
    • {
  "items": [ dba_protocol ]
}
    Property Name Type Description Notes
    dba_protocols <object> DBA Module protocols filters.
    dba_protocols.items <array of <dba_protocol>> Optional;
    dba_protocols.items[items] <dba_protocol> DBA Module protocols filter.

    dba_protocols: get

    Returns the list of application traffic filters rules used in DBA Module.

    GET http://{device}/api/npm.packet_analysis/2.3/dba_protocols
    Response Body

    Returns a dba_protocols data object.

    Resource: dns_protocol

    DNS Module protocols filter.

    http://{device}/api/npm.packet_analysis/2.3/dns_protocols/items/{name}
  • JSON
    • {
  "definitions": app_mapper_definition_list,
  "enabled": boolean,
  "name": string,
  <prop>: any
}
    Property Name Type Description Notes
    dns_protocol <object> DNS Module protocols filter. Required properties: [name, enabled];
    dns_protocol.definitions <app_mapper_definition_list> List of Application Traffic Filters definitions.
    dns_protocol.enabled <boolean> Enable/disable the rule.
    dns_protocol.name <string> DNS Module protocol rule name. Values: DNS;
    dns_protocol.<prop> <any> Optional;

    dns_protocol: get

    Returns the DNS Module traffic filters rule.

    GET http://{device}/api/npm.packet_analysis/2.3/dns_protocols/items/{name}
    Response Body

    Returns a dns_protocol data object.

    dns_protocol: set

    Updates the DNS Module traffic filters rule.

    PUT http://{device}/api/npm.packet_analysis/2.3/dns_protocols/items/{name}
    Request Body

    Provide a dns_protocol data object.

    Response Body

    Returns a dns_protocol data object.

    Resource: dns_protocols

    DNS Module protocols filters.

    http://{device}/api/npm.packet_analysis/2.3/dns_protocols
  • JSON
    • {
  "items": [ dns_protocol ]
}
    Property Name Type Description Notes
    dns_protocols <object> DNS Module protocols filters.
    dns_protocols.items <array of <dns_protocol>> Optional;
    dns_protocols.items[items] <dns_protocol> DNS Module protocols filter.

    dns_protocols: get

    Returns the list of application traffic filters rules used in DNS Module.

    GET http://{device}/api/npm.packet_analysis/2.3/dns_protocols
    Response Body

    Returns a dns_protocols data object.

    Resource: dpi_params

    Packet processing dpi parameters.

    http://{device}/api/npm.packet_analysis/2.3/dpi_params
  • JSON
    • {
  "dpi_enabled": boolean
}
    Property Name Type Description Notes
    dpi_params <object> Packet processing dpi parameters.
    dpi_params.dpi_enabled <boolean> Enable/disable the DPI processing. Optional;

    dpi_params: get

    Returns the dpi parameters configuration.

    GET http://{device}/api/npm.packet_analysis/2.3/dpi_params
    Response Body

    Returns a dpi_params data object.

    dpi_params: set

    Updates the dpi parameters configuration.

    PUT http://{device}/api/npm.packet_analysis/2.3/dpi_params
    Request Body

    Provide a dpi_params data object.

    Response Body

    Returns a dpi_params data object.

    Resource: pfs_params

    TLS PFS configuration.

    http://{device}/api/npm.packet_analysis/2.3/pfs_params
  • JSON
    • {
  "pfs_enabled": boolean,
  "store_pfs_ms": boolean
}
    Property Name Type Description Notes
    pfs_params <object> TLS PFS configuration.
    pfs_params.pfs_enabled <boolean> Enable/disable PFS decryption. Requires user to provide DH keys using 'npm.ssl_dh_keys' API. Optional;
    pfs_params.store_pfs_ms <boolean> Enable/disable PFS keys store in the vault (not implemented). Optional;

    pfs_params: get

    Returns the TLS PFS configuration.

    GET http://{device}/api/npm.packet_analysis/2.3/pfs_params
    Response Body

    Returns a pfs_params data object.

    pfs_params: set

    Updates the TLS PFS configuration.

    PUT http://{device}/api/npm.packet_analysis/2.3/pfs_params
    Request Body

    Provide a pfs_params data object.

    Response Body

    Returns a pfs_params data object.

    Resource: ssl_protocol

    TLS Module protocols filter.

    http://{device}/api/npm.packet_analysis/2.3/ssl_protocols/items/{name}
  • JSON
    • {
  "definitions": app_mapper_definition_list,
  "enabled": boolean,
  "name": string,
  <prop>: any
}
    Property Name Type Description Notes
    ssl_protocol <object> TLS Module protocols filter. Required properties: [name, enabled];
    ssl_protocol.definitions <app_mapper_definition_list> List of Application Traffic Filters definitions.
    ssl_protocol.enabled <boolean> Enable/disable the rule.
    ssl_protocol.name <string> SSL/TLS Module protocol rule name. Values: TLS_HANDSHAKES;
    ssl_protocol.<prop> <any> Optional;

    ssl_protocol: get

    Returns the TLS Module traffic filters rule.

    GET http://{device}/api/npm.packet_analysis/2.3/ssl_protocols/items/{name}
    Response Body

    Returns a ssl_protocol data object.

    ssl_protocol: set

    Updates the TLS Module traffic filters rule.

    PUT http://{device}/api/npm.packet_analysis/2.3/ssl_protocols/items/{name}
    Request Body

    Provide a ssl_protocol data object.

    Response Body

    Returns a ssl_protocol data object.

    Resource: ssl_protocols

    TLS Module protocols filters.

    http://{device}/api/npm.packet_analysis/2.3/ssl_protocols
  • JSON
    • {
  "items": [ ssl_protocol ]
}
    Property Name Type Description Notes
    ssl_protocols <object> TLS Module protocols filters.
    ssl_protocols.items <array of <ssl_protocol>> Optional;
    ssl_protocols.items[items] <ssl_protocol> TLS Module protocols filter.

    ssl_protocols: get

    Returns the list of application traffic filters rules used in TLS Module.

    GET http://{device}/api/npm.packet_analysis/2.3/ssl_protocols
    Response Body

    Returns a ssl_protocols data object.

    Resource: voip_protocol

    UCA Module protocols filter.

    http://{device}/api/npm.packet_analysis/2.3/voip_protocols/items/{name}
  • JSON
    • {
  "definitions": app_mapper_definition_list,
  "enabled": boolean,
  "name": string,
  <prop>: any
}
    Property Name Type Description Notes
    voip_protocol <object> UCA Module protocols filter. Required properties: [name, enabled];
    voip_protocol.definitions <app_mapper_definition_list> List of Application Traffic Filters definitions.
    voip_protocol.enabled <boolean> Enable/disable the rule.
    voip_protocol.name <string> UCA Module protocol rule name. Values: H323, SIP, SKINNY, RTP, MS_TEAMS, ZOOM;
    voip_protocol.<prop> <any> Optional;

    voip_protocol: get

    Returns the UCA Module traffic filters rule.

    GET http://{device}/api/npm.packet_analysis/2.3/voip_protocols/items/{name}
    Response Body

    Returns a voip_protocol data object.

    voip_protocol: set

    Updates the UCA Module traffic filters rule.

    PUT http://{device}/api/npm.packet_analysis/2.3/voip_protocols/items/{name}
    Request Body

    Provide a voip_protocol data object.

    Response Body

    Returns a voip_protocol data object.

    Resource: voip_protocols

    UCA Module protocols filters.

    http://{device}/api/npm.packet_analysis/2.3/voip_protocols
  • JSON
    • {
  "items": [ voip_protocol ]
}
    Property Name Type Description Notes
    voip_protocols <object> UCA Module protocols filters.
    voip_protocols.items <array of <voip_protocol>> Optional;
    voip_protocols.items[items] <voip_protocol> UCA Module protocols filter.

    voip_protocols: get

    Returns the list of application traffic filters rules used in UCA Module.

    GET http://{device}/api/npm.packet_analysis/2.3/voip_protocols
    Response Body

    Returns a voip_protocols data object.

    Resource: wta_protocol

    WTA Module protocols filter.

    http://{device}/api/npm.packet_analysis/2.3/wta_protocols/items/{name}
  • JSON
    • {
  "definitions": app_mapper_definition_list,
  "enabled": boolean,
  "name": string,
  <prop>: any
}
    Property Name Type Description Notes
    wta_protocol <object> WTA Module protocols filter. Required properties: [name, enabled];
    wta_protocol.definitions <app_mapper_definition_list> List of Application Traffic Filters definitions.
    wta_protocol.enabled <boolean> Enable/disable the rule.
    wta_protocol.name <string> WTA Module protocol rule name. Values: WEB;
    wta_protocol.<prop> <any> Optional;

    wta_protocol: get

    Returns the WTA Module traffic filters rule.

    GET http://{device}/api/npm.packet_analysis/2.3/wta_protocols/items/{name}
    Response Body

    Returns a wta_protocol data object.

    wta_protocol: set

    Updates the WTA Module traffic filters rule.

    PUT http://{device}/api/npm.packet_analysis/2.3/wta_protocols/items/{name}
    Request Body

    Provide a wta_protocol data object.

    Response Body

    Returns a wta_protocol data object.

    Resource: wta_protocols

    WTA Module protocols filters.

    http://{device}/api/npm.packet_analysis/2.3/wta_protocols
  • JSON
    • {
  "items": [ wta_protocol ]
}
    Property Name Type Description Notes
    wta_protocols <object> WTA Module protocols filters.
    wta_protocols.items <array of <wta_protocol>> Optional;
    wta_protocols.items[items] <wta_protocol> WTA Module protocols filter.

    wta_protocols: get

    Returns the list of application traffic filters rules used in WTA Module.

    GET http://{device}/api/npm.packet_analysis/2.3/wta_protocols
    Response Body

    Returns a wta_protocols data object.

    Type: app_mapper_definition_list

    List of Application Traffic Filters definitions.

  • JSON
    • [
  {
    "hosts": host_list,
    "transport": transport_rule
  }
]
    Property Name Type Description Notes
    app_mapper_definition_list <array of <object>> List of Application Traffic Filters definitions.
    app_mapper_definition_list[items] <object> Application Traffic Filters details. Required properties: [transport];
    app_mapper_definition_list[items].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_mapper_definition_list[items].
    transport    		 <transport_rule> IP Protocol and transport ports.

    Type: bulk_deleter

    Bulk Deleter configuration.

  • JSON
    • {
  "delete_all": boolean,
  "delete_ids": [
    number
  ],
  <prop>: any
}
    Property Name Type Description Notes
    bulk_deleter <object> Bulk Deleter configuration.
    bulk_deleter.delete_all <boolean> Delete all objects in the given configuration. Optional;
    bulk_deleter.delete_ids <array of <number>> Optional;
    bulk_deleter.delete_ids[items] <number>
    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: transport_rule

    IP Protocol and transport ports.

  • JSON
    • {
  "ip_protocol": string,
  "ports": string
}
    Property Name Type Description Notes
    transport_rule <object> IP Protocol and transport ports. Required properties: [ip_protocol];
    transport_rule.ip_protocol <string> IP protocol. Values: TCP, UDP;
    transport_rule.ports <string> Comma separated list of port ranges. e.g. x, p-q, y-z. Optional;