Skip to content

AlertsApi.md

Latest commit

 

History

History
114 lines (80 loc) · 3.76 KB

AlertsApi.md

File metadata and controls

114 lines (80 loc) · 3.76 KB

purity_fb_1dot12.AlertsApi

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

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

list_alerts

AlertResponse list_alerts(filter=filter, ids=ids, limit=limit, names=names, sort=sort, start=start, 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
filter str The filter to be used for query. [optional]
ids list[str] A comma-separated list of resource IDs. This cannot be provided together with the name or names query parameters. [optional]
limit int limit, should be >= 0 [optional]
names list[str] A comma-separated list of resource names. This cannot be provided together with the ids query parameters. [optional]
sort str Sort the response by the specified fields (in descending order if '-' is appended to the field name). [optional]
start int The offset of the first resource to return from a collection. [optional]
token str An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. [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(alert_settings, names=names)

Update alerts.

Example

from purity_fb import PurityFb, Alert, 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:
    alert_settings = Alert(flagged=False)
    try:
        # unflag an alert with the given id
        res = fb.alerts.update_alerts(
            names=['1'], alert_settings=alert_settings)
        print(res)
    except rest.ApiException as e:
        print("Exception when updating alert: %s\n" % e)

Parameters

Name Type Description Notes
alert_settings Alert
names list[str] A comma-separated list of resource names. This cannot be provided together with the ids query parameters. [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]