Consumers

General information

There is a set of endpoints, which is common for all the consumers, described in this file, plus some consumers have their own specific endpoints, described in separate files.

List of consumers: * Pcap Eye * Consumer key: pcap_eye * File Exporter * Consumer key: file_exporter * File Exporter’s endpoints * Flow Tracker * Consumer key: flow_tracker * Flow Tracker’s endpoints * Pcap Processor * Consumer key: pcap_processor

Endpoints

• Get subscription state
  • path: /consumers/[Consumer key]
  • method: GET
  • data:

  {
      "subscribed": true
  }

• Update subscription state
  • path: /consumers/[Consumer key]
  • method: PUT
  • data: [Consumer subscription state]
• Restart Consumer
  • path: /consumers/[Consumer key]/restart
  • method: POST

The endpoints designed to work with the captured files:

• Read queue size
  • path: /consumers/[Consumer key]/queue
  • method: GET
  • data

  {
      "size": 123
  }

• Read queue size and content
  • path: /consumers/[Consumer key]/queue?list=true
  • method: GET
  • data

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

• Send items to the queue
  • path: /consumers/[Consumer key]/queue
  • method: POST
  • data

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

  • note:
    • if one or more of the path(s) are not present on the /storage/data/captures API, returns bad request
• Clear queue
  • path: /consumers/[Consumer key]/queue
  • method: DELETE

The endpoints designed to work with the imported files:

• Read queue size
  • path: /consumers/[Consumer key]/import_queue
  • method: GET
  • data

  {
      "size": 123
  }

• Read queue size and content
  • path: /consumers/[Consumer key]/import_queue?list=true
  • method: GET
  • data

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

• Send items to the queue
  • path: /consumers/[Consumer key]/import_queue
  • method: POST
  • data

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

  • note:
    • if one or more of the path(s) are not present on the /storage/data/captures API, returns bad request
• Clear queue
  • path: /consumers/[Consumer key]/import_queue
  • method: DELETE

Back to Index