purity_fb.AlertsApi

All URIs are relative to https://purity_fb_server/api

Method HTTP request Description
list_alerts GET /1.2/alerts
update_alerts PATCH /1.2/alerts

list_alerts

AlertResponse list_alerts(names=names, filter=filter, sort=sort, start=start, limit=limit, token=token)

List all alerts

Example

from purity_fb import PurityFb, rest

fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    try:
        res = fb.alerts.list_alerts()
        print(res)
        # list alerts and sort by severity
        res = fb.alerts.list_alerts(sort='severity')
    except rest.ApiException as e:
        print("Exception when listing alert: %s\n" % e)

Parameters

Name Type Description Notes
names list[str] A list of names. [optional]
filter str The filter to be used for query. [optional]
sort str The way to order the results. [optional]
start int start [optional]
limit int limit, should be >= 0 [optional]
token str token [optional]

Return type

AlertResponse

Authorization

AuthTokenHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]

update_alerts

AlertResponse update_alerts(names=names, flagged=flagged)

Update alerts

Example

from purity_fb import PurityFb, AlertWatcher, rest

fb = PurityFb("10.255.9.28") # assume the array IP is 10.255.9.28
fb.disable_verify_ssl()
try:
    res = fb.login(API_TOKEN) # login to the array with your API_TOKEN
except rest.ApiException as e:
    print("Exception when logging in to the array: %s\n" % e)
if res:
    flagged = False
    try:
        # unflag an alert with the given id
        res = fb.alerts.update_alerts(
            names=['1'], flagged=flagged)
        print(res)
    except rest.ApiException as e:
        print("Exception when updating alert watchers: %s\n" % e)

Parameters

Name Type Description Notes
names list[str] A list of names. [optional]
flagged Alert [optional]

Return type

AlertResponse

Authorization

AuthTokenHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to Overview]