Configuration

NVIDIA UFM Cyber-AI Documentation v2.5.1
  • URL

    Copy
    Copied!
                

    PUT /cyber-ai/config/ufm-params

  • Request data

    Copy
    Copied!
                

    { "password": "qwerty", "ip": "10.210.4.57", "username": "admin", "protocol": "[http|https]" "port": 443 }

  • Response codes

    Status

    Description

    204

    Success

    400

    Bad request

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/config/ufm-params

  • Request data

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    none

  • Response codes

    Status

    Description

    200

    Success

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/analytics/summary

  • URL filters

    • From – retrieve alerts triggered within the last given time period

      Copy
      Copied!
                  

      from=-<time>

      Warning

      Supported time units: h (for hours), d (for days), w (for weeks), m (for months). For example: from=-6h.

    • Probability – returns all alerts with probability equal to, or greater than the given probability

      Copy
      Copied!
                  

      min_probability=<0-100>

  • Request data

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    { "network_alerts": { "Critical": 422, "Major": 10, "Minor": 0, "Warning": 0, "Suspect": 0, "Info": 0, "Notice": 0 }, "tenant_alerts": {{…}, "link_failures_predictions": {…}, }, "link_anomaly_predictions": {…}, "cable_events": {…}, "logical_server_alerts": {…}, } }

    Warning

    If successful, the analytics summary will be returned in JSON format.

  • Response codes

    Status

    Description

    204

    Success

    400

    Bad request

Cable Length

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/analytics/distribution/cable-length

  • URL filters

    • from – retrieve cable distributions based on cable’s length with alerts counts from a specific time:

    • to - retrieve cable distributions based on cable’s length with alerts counts until a specific time

    • min_probability – retrieve cable distributions with larger than or equal minimum probability

    • max_probability – retrieve cable distributions with less than or equal maximum probability

      Copy
      Copied!
                  

      from=-<time>&to=-<time>&min_probability=<[0-100]>&max_probability=<[0-100]>

  • Request data

    Copy
    Copied!
                

    none

  • Response

    Copy
    Copied!
                

    { "20":{ "normal": 2090, "alerted": 212 }, "30":{ "normal": 968, "alerted": 487 }

  • Response codes

    Status

    Description

    200

    Success

    400

    Bad request

Cable Technology Type

  • URL

    Copy
    Copied!
                

    GET /cyber-ai/analytics/distribution/cable-type

  • URL filters

    • from – retrieve cable distributions based on cable’s length with alerts counts from a specific time:

    • to - retrieve cable distributions based on cable’s length with alerts counts until a specific time

    • min_probability – retrieve cable distributions with larger than or equal minimum probability

    • max_probability – retrieve cable distributions with less than or equal maximum probability

      Copy
      Copied!
                  

      from=-<time>&to=-<time>&min_probability=<[0-100]>&max_probability=<[0-100]>

  • Request data

    Copy
    Copied!
                

    none

  • Response codes

    Status

    Description

    200

    Success

    400

    Bad request

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