{"id":23708573,"url":"https://github.com/decryptus/updownio","last_synced_at":"2025-06-11T00:35:05.407Z","repository":{"id":65208750,"uuid":"587788345","full_name":"decryptus/updownio","owner":"decryptus","description":"Python wrapper for the updown.io API","archived":false,"fork":false,"pushed_at":"2024-04-12T13:10:12.000Z","size":28,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-30T04:54:50.816Z","etag":null,"topics":["monitoring","python","updown","updown-api","updown-monitoring","updownio"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/decryptus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-11T15:35:06.000Z","updated_at":"2025-01-29T07:39:32.000Z","dependencies_parsed_at":"2024-12-30T18:11:32.437Z","dependency_job_id":null,"html_url":"https://github.com/decryptus/updownio","commit_stats":{"total_commits":5,"total_committers":1,"mean_commits":5.0,"dds":0.0,"last_synced_commit":"a2426ce7ff3df27eceb99f7ede5cc070fd47205e"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decryptus%2Fupdownio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decryptus%2Fupdownio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decryptus%2Fupdownio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decryptus%2Fupdownio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/decryptus","download_url":"https://codeload.github.com/decryptus/updownio/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decryptus%2Fupdownio/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259176341,"owners_count":22817174,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["monitoring","python","updown","updown-api","updown-monitoring","updownio"],"created_at":"2024-12-30T18:01:20.902Z","updated_at":"2025-06-11T00:35:05.350Z","avatar_url":"https://github.com/decryptus.png","language":"Python","readme":"## updownio project\n\n[![PyPI pyversions](https://img.shields.io/pypi/pyversions/updownio.svg)](https://pypi.org/project/updownio/)\n[![PyPI version shields.io](https://img.shields.io/pypi/v/updownio.svg)](https://pypi.org/project/updownio/)\n[![Documentation Status](https://readthedocs.org/projects/updownio/badge/?version=latest)](https://updownio.readthedocs.io/)\n\nupdownio is a free and open-source, it's a python wrapper for the updown.io API.\n\n## Installation\n\n`pip install updownio`\n\n## Environment variables\n\n| Variable                 | Description                 | Default |\n|:-------------------------|:----------------------------|:--------|\n| `UPDOWN_ACCEPT`          | HTTP Accept request-header  | application/json |\n| `UPDOWN_ACCEPT_ENCODING` | HTTP Accept-Encoding request-header | gzip |\n| `UPDOWN_API_KEY`         | API key for authentication  | \u003cspan/\u003e |\n| `UPDOWN_ENDPOINT`        | API Endpoint                | https://updown.io |\n| `UPDOWN_TIMEOUT       `  | Request timeout in seconds  | 60 |\n\n## Usage\n\n### Import library\n\n```python\nimport updownio\n```\n\n### Initialize service with arguments\n\n```python\nupdown_checks = updownio.service('checks',\n                                 api_key  = 'xxxxxxxxxxx',\n                                 endpoint = 'https://example.org/api',\n                                 timeout  = 3600)\n```\n\n### Endpoints\n\n#### Checks\n\n##### List all your checks\n\n```python\nchecks = updownio.service('checks').list()\n```\n\n##### Show a single check\n\nSelect check by token\n\n```python\ncheck = updownio.service('checks').show(token = 'xxxx')\n```\nor by URL\n\n```python\ncheck = updownio.service('checks').show(url = 'https://example.org')\n```\n\n##### Get all the downtimes of a check\n\nSelect downtimes by token\n\n```python\ncheck = updownio.service('checks').downtimes(token = 'xxxx'\n                                             params = {'page': 1,\n                                                       'results': False})\n```\nor by URL\n\n```python\ncheck = updownio.service('checks').downtimes(url = 'https://example.org')\n```\n\n##### Get detailed metrics about the check\n\nSelect metrics by token\n\n```python\ncheck = updownio.service('checks').metrics(token = 'xxxx',\n                                           params = {'from': '2022-12-16 15:11:17 +0100',\n                                                     'to': '2023-01-16 15:11:17 +0100',\n                                                     'group': 'host'})\n```\nor by URL\n\n```python\ncheck = updownio.service('checks').metrics(url = 'https://example.org')\n```\n\n##### Add a new check\n\n```python\ncheck = updownio.service('checks').add('https://example.org',\n                                       data = {'apdex_t': 2.0,\n                                               'disabled_locations': ['fra', 'syd'],\n                                               'period': 3600,\n                                               'recipients': ['email:xxxxxxxx', 'slack:xxxxxxxx']})\n```\n\n##### Update a check\n\nSelect check by token\n\n```python\ncheck = updownio.service('checks').update(token = 'xxxx',\n                                          data = {'apdex_t': 1.0,\n                                                  'disabled_locations': ['fra', 'syd'],\n                                                  'recipients': ['email:xxxxxxxx', 'slack:xxxxxxxx']})\n```\nor by URL\n\n```python\ncheck = updownio.service('checks').update(url = 'https://example.org',\n                                          data = {'apdex_t': 1.0,\n                                                  'disabled_locations': ['fra', 'syd'],\n                                                  'recipients': ['email:xxxxxxxx', 'slack:xxxxxxxx']})\n```\n\n##### Delete a check\n\nSelect check by token\n\n```python\nupdownio.service('checks').delete(token = 'xxxx')\n```\nor by URL\n\n```python\nupdownio.service('checks').delete(url = 'https://example.org')\n```\n\n#### Nodes\n\n##### List all updown.io monitoring nodes\n\n```python\nnodes = updownio.service('nodes').list()\n```\n\n##### List all updown.io monitoring nodes IPv4 addresses\n\n```python\nnodes = updownio.service('nodes').ipv4()\n```\n\n##### List all updown.io monitoring nodes IPv6 addresses\n\n```python\nnodes = updownio.service('nodes').ipv6()\n```\n\n#### Recipients\n\n##### List all the possible alert recipients/channels on your account\n\n```python\nrecipients = updownio.service('recipients').list()\n```\n\n##### Add a new recipient\n\n```python\nrecipients = updownio.service('recipients').add(xtype = 'email',\n                                                value = 'xxxxxxxx',\n                                                data = {'selected': True})\n```\n\n##### Delete a recipient\n\n```python\nupdownio.service('recipients').delete(xid = 'email:xxxxxxxx')\n```\n\n#### Status pages\n\n##### List all your status pages\n\n```python\nstatus_pages = updownio.service('status_pages').list()\n```\n\n##### Add a new status page\n\n```python\nstatus_page = updownio.service('status_pages').add(['xxxx', 'yyyy', 'zzzz'],\n                                                   data = {'name': 'foo',\n                                                           'description': 'bar'})\n```\n\n##### Update a status page\n\n```python\nstatus_page = updownio.service('status_pages').update(token = 'xxxx',\n                                                      data = {'checks': ['xxxx', 'zzzz'],\n                                                              'name': 'spam',\n                                                              'description': 'ham'})\n```\n\n##### Delete a status page\n\n```python\nupdownio.service('status_pages').delete(token = 'xxxx')\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecryptus%2Fupdownio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdecryptus%2Fupdownio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecryptus%2Fupdownio/lists"}