uptime-kuma-api

Release v1.2.1. (Installation)

A Python wrapper for the Uptime Kuma Socket.IO API

---

Indices and tables

• Index

• Search Page

API Reference

If you are looking for information on a specific function, class, or method, this part of the documentation is for you.

• Main Interface
  • UptimeKumaApi
    • connect()
    • disconnect()
    • get_monitors()
    • get_monitor()
    • pause_monitor()
    • resume_monitor()
    • delete_monitor()
    • get_monitor_beats()
    • get_game_list()
    • test_chrome()
    • add_monitor()
    • edit_monitor()
    • add_monitor_tag()
    • delete_monitor_tag()
    • get_notifications()
    • get_notification()
    • test_notification()
    • add_notification()
    • edit_notification()
    • delete_notification()
    • check_apprise()
    • get_proxies()
    • get_proxy()
    • add_proxy()
    • edit_proxy()
    • delete_proxy()
    • get_status_pages()
    • get_status_page()
    • add_status_page()
    • delete_status_page()
    • save_status_page()
    • post_incident()
    • unpin_incident()
    • get_heartbeats()
    • get_important_heartbeats()
    • avg_ping()
    • cert_info()
    • uptime()
    • info()
    • clear_events()
    • clear_heartbeats()
    • clear_statistics()
    • get_tags()
    • get_tag()
    • add_tag()
    • edit_tag()
    • delete_tag()
    • get_settings()
    • set_settings()
    • change_password()
    • upload_backup()
    • twofa_status()
    • prepare_2fa()
    • verify_token()
    • save_2fa()
    • disable_2fa()
    • login()
    • login_by_token()
    • logout()
    • need_setup()
    • setup()
    • get_database_size()
    • shrink_database()
    • get_docker_hosts()
    • get_docker_host()
    • test_docker_host()
    • add_docker_host()
    • edit_docker_host()
    • delete_docker_host()
    • get_maintenances()
    • get_maintenance()
    • add_maintenance()
    • edit_maintenance()
    • delete_maintenance()
    • pause_maintenance()
    • resume_maintenance()
    • get_monitor_maintenance()
    • add_monitor_maintenance()
    • get_status_page_maintenance()
    • add_status_page_maintenance()
    • get_api_keys()
    • get_api_key()
    • add_api_key()
    • enable_api_key()
    • disable_api_key()
    • delete_api_key()
    • get_monitor_status()
• Enums
  • AuthMethod
    • NONE
    • HTTP_BASIC
    • NTLM
    • MTLS
    • OAUTH2_CC
  • MonitorType
    • GROUP
    • HTTP
    • PORT
    • PING
    • KEYWORD
    • JSON_QUERY
    • GRPC_KEYWORD
    • DNS
    • DOCKER
    • REAL_BROWSER
    • PUSH
    • STEAM
    • GAMEDIG
    • MQTT
    • KAFKA_PRODUCER
    • SQLSERVER
    • POSTGRES
    • MYSQL
    • MONGODB
    • RADIUS
    • REDIS
    • TAILSCALE_PING
  • MonitorStatus
    • DOWN
    • UP
    • PENDING
    • MAINTENANCE
  • NotificationType
    • ALERTA
    • ALERTNOW
    • ALIYUNSMS
    • APPRISE
    • BARK
    • CLICKSENDSMS
    • DINGDING
    • DISCORD
    • FEISHU
    • FLASHDUTY
    • FREEMOBILE
    • GOALERT
    • GOOGLECHAT
    • GORUSH
    • GOTIFY
    • HOMEASSISTANT
    • KOOK
    • LINE
    • LINENOTIFY
    • LUNASEA
    • MATRIX
    • MATTERMOST
    • NOSTR
    • NTFY
    • OCTOPUSH
    • ONEBOT
    • OPSGENIE
    • PAGERDUTY
    • PAGERTREE
    • PROMOSMS
    • PUSHBULLET
    • PUSHDEER
    • PUSHOVER
    • PUSHY
    • ROCKET_CHAT
    • SERVERCHAN
    • SERWERSMS
    • SIGNAL
    • SLACK
    • SMSC
    • SMSEAGLE
    • SMSMANAGER
    • SMTP
    • SPLUNK
    • SQUADCAST
    • STACKFIELD
    • TEAMS
    • PUSHBYTECHULUS
    • TELEGRAM
    • TWILIO
    • WEBHOOK
    • WECOM
    • ZOHOCLIQ
  • ProxyProtocol
    • HTTPS
    • HTTP
    • SOCKS
    • SOCKS5
    • SOCKS5H
    • SOCKS4
  • IncidentStyle
    • INFO
    • WARNING
    • DANGER
    • PRIMARY
    • LIGHT
    • DARK
  • DockerType
    • SOCKET
    • TCP
  • MaintenanceStrategy
    • MANUAL
    • SINGLE
    • RECURRING_INTERVAL
    • RECURRING_WEEKDAY
    • RECURRING_DAY_OF_MONTH
    • CRON
• Exceptions
  • UptimeKumaException
  • Timeout