Alert Filters

NVIDIA UFM Cyber-AI Documentation v2.5.0
  • URL

    Copy
    Copied!
                

    POST /cyber-ai/alerts/filter

  • Request Data

    Copy
    Copied!
                

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

  • Response

    Copy
    Copied!
                

    { "filter_id": 100, }

  • Response codes

    Status

    Description

    201

    Created

    400

    Bad Request (invalid argument)

  • URL

    Copy
    Copied!
                

    DELETE /cyber-ai/alerts/filter/{filter_id}

  • Request Data

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    none

  • Response codes

    Status

    Description

    200

    Successful

    404

    Not found

  • URL

    Copy
    Copied!
                

    PUT /cyber-ai/alerts/filter

  • Request Data

    Copy
    Copied!
                

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

  • Response

    Copy
    Copied!
                

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

  • Response codes

    Status

    Description

    200

    Success

    404

    Not found

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/alerts/filter

  • URL filters:

    • Type – retrieve alerts of specific type (or all types if this filter is not used)

      Copy
      Copied!
                  

      ?type=<alert_type>

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

  • Request Data

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    [ { "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

    Status

    Description

    200

    Success

    400

    Bad request

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/alerts/filter/{filter_id}

  • Request Data

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

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

  • Response codes

    Status

    Description

    200

    Success

    404

    Not found

© Copyright 2023, NVIDIA. Last updated on Sep 5, 2023.