Skip to content

AlertApi.md

Latest commit

 

History

History
67 lines (49 loc) · 2.34 KB

AlertApi.md

File metadata and controls

67 lines (49 loc) · 2.34 KB
Raw

notehub_py.AlertApi

All URIs are relative to https://api.notefile.net

Method HTTP request Description
get_alerts GET /v1/projects/{projectOrProductUID}/alerts

get_alerts

GetAlerts200Response get_alerts(project_or_product_uid, page_size=page_size, page_num=page_num, monitor_uid=monitor_uid)

Get list of defined Alerts

Example

import notehub_py
from notehub_py.models.get_alerts200_response import GetAlerts200Response
from notehub_py.rest import ApiException
from pprint import pprint

configuration = notehub_py.Configuration(access_token="PERSONAL_ACCESS_TOKEN")

# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = notehub_py.AlertApi(api_client)
    project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8"  # str |
    page_size = 50  # int |  (optional) (default to 50)
    page_num = 1  # int |  (optional) (default to 1)
    monitor_uid = "monitor_uid_example"  # str |  (optional)

    try:
        api_response = api_instance.get_alerts(
            project_or_product_uid,
            page_size=page_size,
            page_num=page_num,
            monitor_uid=monitor_uid,
        )
        print("The response of AlertApi->get_alerts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AlertApi->get_alerts: %s\n" % e)

Parameters

Name Type Description Notes
project_or_product_uid str
page_size int [optional] [default to 50]
page_num int [optional] [default to 1]
monitor_uid str [optional]

Return type

GetAlerts200Response

Authorization

personalAccessToken

HTTP request headers

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