Metadata

Manage traffic analysis metadata

API

• Retrieve information about the stored metadata

  • Path: /metadata

  • Method: GET

  • Response:

    {
        "size": 3482904
    }

  • Different platforms retrieve metadata in distinct ways:

    • Edge: Gathers metadata through the flow-tracker and pcap-processor. It sends requests such as GET /v1/metadata and GET /metadata.
    • Core10: Retrieves metadata from the flow-tracker using the request GET /v1/metadata.
• Clean metadata in time range
  • Path: /metadata
  • Method: DELETE
  • Arguments:
    • URL parameters :
      • start_ts - beginning of time range of metadata cleanup, epoch in nsec
      • end_ts - end of time range of metadata cleanup, epoch in nsec
  • Notes:
    • deletion is asynchronous
    • if neither of the arguments is specified, all metadata is removed
    • If start_ts is set, metadata from start_ts up to the latest will be removed. If end_ts is set, metadata up to end_ts will be removed.
    • sends request to flow-tracker DELETE /v1/metadata/range
    • sends request to pcap-processor DELETE /metadata/range (IOTA Edge system only)
  • Restrictions
    • only a single range, delete all operation can run at the same time
    • the device must not be capturing
    • the automatic cleanup must not be in progress
• Clean all metadata
  • Path: /metadata
  • Method: DELETE
  • Notes:
    • deletion is asynchronous
    • sends request to flow-tracker DELETE /v1/metadata/all
    • sends request to pcap-processor DELETE /metadata/all (IOTA Edge system only)
  • Restrictions
    • only a single range, delete all operation can run at the same time
    • the device must not be capturing
    • the automatic cleanup must not be in progress

Back to Index