Configuration | NVIDIA UFM Cyber-AI Documentation

Set UFM Enterprise Connections Parameters

URL
```
PUT /cyber-ai/config/ufm-params
```

Request data

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

Response codes

Status	Description
204	Success
400	Bad request

Get UFM Enterprise Connections Parameters

URL
```
GET /cyber-ai/config/ufm-params
```
Request data
```
none
```
Response
```
none
```

Response codes

Status	Description
200	Success

Alert Count Summary

URL
```
GET /cyber-ai/analytics/summary
```
URL filters
From – retrieve alerts triggered within the last given time period from=-<time> 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 min_probability=<0-100>
Request data
```
none
```

Response

{
    "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": {…},
    }
   }

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

Response codes

Status	Description
204	Success
400	Bad request

Cable Distribution Count

Cable Length

URL

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
  from=-<time>&to=-<time>&min_probability=<[0-100]>&max_probability=<[0-100]>
Request data
```
none
```

Response

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

Response codes

Status	Description
200	Success
400	Bad request

Cable Technology Type

URL

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

URL filtersfrom – 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 timemin_probability – retrieve cable distributions with larger than or equal minimum probabilitymax_probability – retrieve cable distributions with less than or equal maximum probability from=-<time>&to=-<time>&min_probability=<[0-100]>&max_probability=<[0-100]>
Request data
```
none
```

Response codes

Status	Description
200	Success
400	Bad request

Last updated: April 22, 2022