Metadata

Read the size of the flow metadata and delete it

Flow metadata is the result of the traffic analysis, stored in the metadata database on the data disk. It can be deleted for a time range or completely, for example to free disk space or to remove the traces of a measurement. The share of the disk reserved for metadata is set on the Disk Share page.

API

• Get the size of the stored metadata

  • Path: /api/metadata

  • Method: GET

  • Minimum user role: viewer

  • Response on success (200 OK):

    {
        "message": "Success",
        "data": {
            "size": 122660261888
        }
    }

    • size - bytes occupied by metadata. The value is derived from the disk usage: everything used on the data disk that is not a capture file counts as metadata.

  • Response on failure (500 Internal Server Error): {"message": "could not get size of metadata: <reason>", "data": null}

• Delete metadata
  • Path: /api/metadata
  • Method: DELETE
  • Minimum user role: operator
  • URL parameters:
    • start_ts - optional, epoch nanoseconds; metadata from this time on is deleted
    • end_ts - optional, epoch nanoseconds; metadata up to this time is deleted
  • Selection: with start_ts or end_ts (or both) the given range is deleted, a missing bound meaning the beginning or the end of the stored data; without parameters all metadata is deleted
  • Response on success (200 OK): {"message": "Successfully started erasing process for traffic metadata, from <start> till <end> (UTC). This will continue in background.", "data": null} for a range, {"message": "Successfully started erasing process for all traffic metadata. This will continue in background.", "data": null} for everything
  • Response on failure (400 Bad Request): {"message": "could not delete metadata: <reason>", "data": null}, where the reason is
    • start timestamp (<start>) must be less than end timestamp (<end>)
    • cannot start metadata deletion while the automatic cleanup is in progress
    • an error reported by the metadata database
  • Notes: deletion runs in the background; the size reported by GET decreases while it progresses. Only one deletion can run at a time.

Back to Index