• format: json object
• fields:
  • key: hash: string or null
  • path: path to pcap on filesystem: string
  • file_size: size of the pcap file in bytes: 64-bit unsigned
  • start_ts: epoch (nanoseconds) to first packet in the pcap file: 64-bit unsigned or null

• format: json object
• fields:
  • page: current page
  • page_count: number of pages
  • total_count: total number of results
  • data: array of fs_entry object

query arguments * page: selects the page * results_per_page: sets the maximum number of entries displayed per page, default: 5000

• path: /storage/data
• method: GET
• data
  • format: json object
  • fields:
    • disk_usage
      • used: used space in bytes
      • total: total space in bytes
• cleanup_in_progress: boolean, automatic cleanup is in progress

  • example:

        {
            "disk_space":
                {
                    "total":17056493568,
                    "used":15184343040
    },
     "cleanup_in_progress": false
        }

• path: /storage/data/captures
• method: GET
• data
  • format: json object
  • fields:
    • page: unsigned integer (1...n), default: 1
    • page_count: unsigned integer, default: 5000
    • order: "asc" (ascending) | "desc" (descending) (default: "asc")
    • data
      • paging response object

    • example

      {
          "page":1,
          "page_count":1,
          "total_count":4,
          "data":
          [
              {
                  "key":"d83e3d630351e1ec752711e92fedcaf977e7dc1b1aa9698f71a4cb41675049ce",
                  "path":"/data/captures/1.pcap",
                  "file_size":1508,
                  "start_ts":1102274184312453000,
                  "pending_deletion": false
              },
              {
                  "key":"d83e3d630351e1ec752711e92fedcaf977e7dc1b1aa9698f71a4cb41675049cf",
                  "path":"/data/captures/2.pcap",
                  "file_size":3202,
                  "start_ts":1102274184317113000,
                  "pending_deletion": false
              },
              {
                  "key":"d83e3d630351e1ec752711e92fedcaf977e7dc1b1aa9698f71a4cb41675049cg",
                  "path":"/data/captures/3.pcap",
                  "file_size":4442,
                  "start_ts":1102274184227453000,
                  "pending_deletion": false
              },
              {
                  "key":null,
                  "path":"/data/captures/3.pcap",
                  "file_size":3339,
                  "start_ts":null,
                  "pending_deletion": false
              }
          ]
      }

• path: /storage/data/captures
• method: GET
• header: paths: ["path-1", ..., "path-n"]
  • if one of the paths don't exist, it will return 404
• data
  • paging response object
  • order: by path ascending

• path: /storage/data/captures
• method: GET
• argument:
  • start_ts: epoch (nanoseconds): 64-bit unsigned
  • end_ts: epoch (nanoseconds): 64-bit unsigned
    • restriction: both start_ts, end_ts must be present
  • order: "asc" (ascending) | "desc" (descending) (default: "asc")
• data
  • paging response object
  • order: by start_ts ascending
• notes
  • entries without timestamp will be skipped

• path: /storage/data/captures
• method: POST
• data: pcap-ng file to import

• path: /storage/data/captures
• method: DELETE
• header: paths: ["path-1", ..., "path-n"]
• argument:
  • list: string flag (true/false): returns the list of deleted captures (default: false)
• behavior
  • deletion is done asynchronously
  • meanwhile, the field, pending_deletion is set to true

• path: /storage/data/captures
• method: DELETE
• argument:
  • start_ts: epoch (nanoseconds): 64-bit unsigned
  • end_ts: epoch (nanoseconds): 64-bit unsigned
  • list: string flag (true/false): returns the list of deleted captures (default: false)
• behavior
  • deletion is done asynchronously
  • meanwhile, the field, pending_deletion is set to true

• path: /storage/data/captures
• method: DELETE
• behavior
  • deletion is done asynchronously
  • meanwhile, the field, pending_deletion is set to true
• restriction: doesn't return list of deleted items

• path: /storage/data/captures/joined
• method: GET
• header: paths: ["path-1", ..., "path-n"]
  • if one of the paths don't exist, it will return 404

  • if the frontend is unable to send headers, token can be used instead (*):

       GET /storage/data/captures/joined?token=fcfa8093cf491577d84fa8a37572cc3f

• arguments
  • start_ts: epoch (nanoseconds): 64-bit unsigned
  • end_ts: epoch (nanoseconds): 64-bit unsigned
  • from: grafana timestamp format
  • to: grafana timestamp format
  • var-esinterface: interface filters; there can be more than one field with this name (TODO: not implemented)
  • var-Filters: filters to be applied onto the packets of the given interval; there can be more than one field with this name
  • var-BPF: BPF filter to be applied; zero or one fields of this name can be in the query
  • var-BPF_op: operation, under which var-Filters and var-BPF filters are to be concatenated; two possible values for this field are OR and AND; by default, AND is used
  • token: string (*)
  • html_errors: bool ("true" or "false"): returns errors as HTML
• data: joined captures (pcap)
• notes:
  • either paths in header or start_ts/end_ts/from/to in arguments must be specified, but not both
  • if paths is not present, either start_ts or end_ts or from/to must be specified, but not both

• path: /storage/data/captures/joined?get_token=true
• method: POST
• header: paths: ["path-1", ..., "path-n"]

• example:

  {"token": "fcfa8093cf491577d84fa8a37572cc3f"}

  Back to Index