image image image image image

On This Page

Add Alerts Filter

  • URL

    POST /cyber-ai/alerts/filter
  • Request Data 

    {
      "filter_type": "link_anomaly",
      "filter_elements": "0x35b286a72f6dc42:15",
      "filter_attributes": "hist1,  hist2,  hist3",
      "enabled": [
        true|false
      ]
    }
  • Response

    {
      "filter_id":  100,
    }
  • Response codes

    StatusDescription
    201Created
    400Bad Request (invalid argument)

Delete Alert Filter

  • URL

    DELETE /cyber-ai/alerts/filter/{filter_id}
  • Request Data

    none
  • Response

    none
  • Response codes

    StatusDescription
    200Successful
    404Not found

Enable Alert Filter

  • URL

    PUT /cyber-ai/alerts/filter
  • Request Data 

    {
      "filter_id":  100,
      "enabled" : [true|false]
    }
  • Response

    {
      "filter_id": 100,
      "filter_type": "link_anomaly",
      "filter_elements": "0x35b286a72f6dc42:15",
      "filter_attributes": "hist1,  hist2,  hist3",
      "enabled": [true|false]
     }
  • Response codes

    StatusDescription
    200Success
    404Not found

Get Alerts Filter

  • URL

    GET /cyber-ai/alerts/filter
  • URL filters:
    • Type – retrieve alerts of specific type (or all types if this filter is not used)

      ?type=<alert_type>

      Supported types: link_failure_prediction, link_anomaly, cable_event, tenant_alert, network_alert and logical_server_alert

  • Request Data

    none
  • Response

    [
      {
        "filter_id": 1,
        "filter_type": "link_anomaly",
        "filter_elements": "0x35b286a72f6dc42:15",
        "filter_attributes": "hist1, hist2, hist3",
        "enabled": true
      },
      {
        "filter_id": 2,
        "filter_type": "link_anomaly",
        "filter_elements": "0x35b286a72f6dc42:16",
        "filter_attributes": "hist1, hist2, hist3",
        "enabled": false
      }
     ]
  • Response codes

    StatusDescription
    200Success
    400Bad request

Get Alert Filter

  • URL

    GET /cyber-ai/alerts/filter/{filter_id}
  • Request Data

    none
  • Response

    {
      "filter_id": 1,
      "filter_type": "link_anomaly",
      "filter_elements": "0x35b286a72f6dc42:15",
      "filter_attributes": "hist1, hist2, hist3",
      "enabled": true
     }
  • Response codes

    StatusDescription
    200Success
    404Not found