Packet Export API v1.3
Created Dec 18, 2020 at 07:09 PM

Resource: export

Configuration, status and statistics of an export.

http://{device}/api/npm.packet_export/1.3/exports/items/{+id}
  • JSON
  • {
      "config": {
        "connection_timeout_msec": integer,
        "end_time": string,
        "filters": {
          "items": filters_list
        },
        "handle_timeout_msec": integer,
        "mode": string,
        "output_filename": string,
        "output_format": string,
        "path": string,
        "snap_length": integer,
        "start_time": string,
        "stop_rule": {
          "packet_limit": integer,
          "size_limit": integer,
          "time_limit": integer
        },
        "time_intervals": [ time_interval_t ]
      },
      "id": string,
      "status": {
        "creation_time": string,
        "error": {
          "error_id": string,
          "error_metrics": async_error_metrics_list,
          "error_text": string
        },
        "owner": string,
        "progress": number,
        "state": string,
        "stats": {
          "dropped_packets": integer,
          "estimated_bytes": integer,
          "estimated_packets": integer,
          "exported_bytes": integer,
          "exported_packets": integer,
          "processed_packets": integer,
          "total_bytes": integer,
          "truncated": boolean
        }
      },
      <prop>: any
    }
    Property Name Type Description Notes
    export <object> Configuration, status and statistics of an export.
    export.config <object> Configuration of an export. Required properties: [path]; Optional;
    export.config.connection_timeout_msec <integer> Max period of time for which the handle waits for a user action (e.g starts to download the packets, set PREPARE mode, etc). Optional; Default is 180000;
    export.config.end_time <string> Time (seconds from epoch) at which export is to end. Optional;
    export.config.filters <object> Collection of filter criteria. Optional;
    export.config.filters.items <filters_list> Array of filter criteria.
    export.config.handle_timeout_msec <integer> Period of time for which the export handle is available after the packets download is terminated. Optional;
    export.config.mode <string> Export mode. Optional; Values: LIVE_STREAM, BUFFER_STREAM, STREAM_TO_FILE, LEGACY, PREPARE;
    export.config.output_filename <string> If sending packets to file, the filename within the probe file system. Optional;
    export.config.output_format <string> Output format type. Optional; Values: PCAP_US, PCAP_NS, PCAPNG_US, PCAPNG_NS;
    export.config.path <string> Path of the source to open.
    export.config.snap_length <integer> Packet snap length for this export. Optional; Default is 65535;
    export.config.start_time <string> Time (seconds from epoch) at which export is to begin. Optional;
    export.config.stop_rule <object> Stop rule for an export. Optional;
    export.config.stop_rule.packet_limit <integer> Max number of packets. Optional;
    export.config.stop_rule.size_limit <integer> Max bytes of packet data. Optional;
    export.config.stop_rule.time_limit <integer> Max time in seconds. Optional;
    export.config.time_intervals <array of <time_interval_t>> Array of time intervals. Optional;
    export.config.time_intervals[items] <time_interval_t> Time interval.
    export.id <string> Export unique identifier. Read-only; Optional;
    export.status <object> Status of an export. Optional;
    export.status.creation_time <string> Time at which the export was created. Read-only; Optional;
    export.status.error <object> Asynchronous task error object. Required properties: [error_id, error_text]; Optional;
    export.status.error.error_id <string> Error code.
    export.status.error.error_metrics <async_error_metrics_list> Array of key/value error metrics, used for detailed error responses from async tasks.
    export.status.error.error_text <string> Error text.
    export.status.owner <string> User who initiated the export. Read-only; Optional;
    export.status.progress <number> Processing progress including both filtering and buffering/streaming. Read-only; Optional;
    export.status.state <string> Export state. Optional; Values: UNINITIALIZED, INITIALIZING, READY, RUNNING, STREAMING, ERRORS, NODATA, DONE;
    export.status.stats <object> Statistics of an export. Optional;
    export.status.stats.dropped_packets <integer> Number of dropped packets. Read-only; Optional;
    export.status.stats.estimated_bytes <integer> Estimated number of bytes that will be exported. Read-only; Optional;
    export.status.stats.estimated_packets <integer> Estimated number of packets that will be exported. Read-only; Optional;
    export.status.stats.exported_bytes <integer> Number of exported bytes. Read-only; Optional;
    export.status.stats.exported_packets <integer> Number of exported packets. Read-only; Optional;
    export.status.stats.processed_packets <integer> Number of processed packets. Read-only; Optional;
    export.status.stats.total_bytes <integer> Approximate number of bytes in the input. Read-only; Optional;
    export.status.stats.truncated <boolean> True in case the output has been truncated. Optional;
    export.<prop> <any> Optional;

    Resource: exports

    Collection of exports on the device.

    http://{device}/api/npm.packet_export/1.3/exports
  • JSON
  • {
      "items": [ export ]
    }
    Property Name Type Description Notes
    exports <object> Collection of exports on the device.
    exports.items <array of <export>> Array of exports. Optional;
    exports.items[items] <export> Configuration, status and statistics of an export.

    Type: async_error_metrics_list

    Array of key/value error metrics, used for detailed error responses from async tasks.

  • JSON
  • [
      {
        "key": string,
        "value": string
      }
    ]
    Property Name Type Description Notes
    async_error_metrics_list <array of <object>> Array of key/value error metrics, used for detailed error responses from async tasks.
    async_error_metrics_list[items] <object> Individual error key/value. Required properties: [key, value];
    async_error_metrics_list[items].key <string> Error metric ID.
    async_error_metrics_list[items].value <string> Error metric value.

    Type: filters_list

    Array of filter criteria.

  • JSON
  • [
      {
        "context": string,
        "id": string,
        "type": string,
        "value": string
      }
    ]
    Property Name Type Description Notes
    filters_list <array of <object>> Array of filter criteria.
    filters_list[items] <object> Filter Required properties: [id, type, value];
    filters_list[items].context <string> Context from which the filter was applied (e.g., user request, data drill-down, etc). Optional; Values: NONE, INTERNAL, USER, DRILL_DOWN;
    filters_list[items].id <string> Filter criterion ID.
    filters_list[items].type <string> The type of filter used on the data. Values: BPF, STEELFILTER, WIRESHARK;
    filters_list[items].value <string> Query filter text to use.

    Type: time_interval_t

    Time interval.

  • JSON
  • {
      "end_time": string,
      "start_time": string
    }
    Property Name Type Description Notes
    time_interval_t <object> Time interval. Required properties: [start_time, end_time];
    time_interval_t.end_time <string> Time (seconds from epoch) at which the interval ends.
    time_interval_t.start_time <string> Time (seconds from epoch) at which the interval begins.