• Consumers endpoint

  • Consumer keys:
    • Pcap Eye
      • Consumer key: "pcap_eye"
    • Sentinel
      • Consumer key: "sentinel"
  • Objects
    • Consumer state
      • format: json object
      • fields:
        • subscribed: enables writing on consumer's queue

      • example

        {
        "subscribed":true
        }

  • Read state
    • path: /consumers/[Consumer key]
    • method: GET
    • data: [Consumer state]
  • Update state
    • path: /consumers/[Consumer key]
    • method: PUT
    • data: [Consumer state]
  • Read queue size
    • path: /consumers/[Consumer key]/queue
    • method: GET
    • data
      • format: json array
      • fields:
        • size: unsigned

    • example

      {
      "size": 123,
       }

  • Read queue size and content
    • path: /consumers/[Consumer key]/queue?list=true
    • method: GET
    • data
      • format: json object
      • fields:
        • size: unsigned
        • content: array of strings

    • example

      {
      "size": 123,
      "content":
      [
          "/data/profisight/captures/capture_801f1239dacd_00012_20210528123450.pcapng",
          "/data/profisight/captures/capture_801f1239dacd_00034_20210528124550.pcapng",
          ...
      ]
       }

  • Clear queue
    • path: /consumers/[Consumer key]/queue
    • method: DELETE
• Send items on queue
  • path: /consumers/[Consumer key]/queue
  • method: POST
  • data
    • format: json object, array of strings (full path)

  • example payload

    [
        "/data/profisight/captures/capture_801f1239dacd_00012_20210528123450.pcapng",
        "/data/profisight/captures/capture_801f1239dacd_00034_20210528124550.pcapng",
        ...
    ]

  • behavior
    • if one or more of the path(s) are not present on the /storage/data/captures API, returns bad request
  • Restart Consumer
    • path: /consumers/[Consumer key]/restart
    • method: POST

Back to Index