{"id":13686521,"url":"https://github.com/lucasheld/ansible-uptime-kuma","last_synced_at":"2026-01-17T11:24:47.903Z","repository":{"id":53253020,"uuid":"509771484","full_name":"lucasheld/ansible-uptime-kuma","owner":"lucasheld","description":"Ansible collection of modules to configure Uptime Kuma","archived":false,"fork":false,"pushed_at":"2024-04-10T20:35:17.000Z","size":270,"stargazers_count":163,"open_issues_count":19,"forks_count":20,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-05-01T09:38:59.755Z","etag":null,"topics":["ansible","ansible-collection","uptime-kuma"],"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/lucasheld.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2022-07-02T14:04:57.000Z","updated_at":"2025-04-23T05:28:37.000Z","dependencies_parsed_at":"2024-11-12T09:42:33.257Z","dependency_job_id":null,"html_url":"https://github.com/lucasheld/ansible-uptime-kuma","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/lucasheld/ansible-uptime-kuma","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasheld%2Fansible-uptime-kuma","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasheld%2Fansible-uptime-kuma/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasheld%2Fansible-uptime-kuma/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasheld%2Fansible-uptime-kuma/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lucasheld","download_url":"https://codeload.github.com/lucasheld/ansible-uptime-kuma/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasheld%2Fansible-uptime-kuma/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28507141,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T10:25:30.148Z","status":"ssl_error","status_checked_at":"2026-01-17T10:25:29.718Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["ansible","ansible-collection","uptime-kuma"],"created_at":"2024-08-02T15:00:34.365Z","updated_at":"2026-01-17T11:24:47.872Z","avatar_url":"https://github.com/lucasheld.png","language":"Python","funding_links":[],"categories":["ansible","Python"],"sub_categories":[],"readme":"# ansible-uptime-kuma\n\nThis collection contains modules that allow to configure [Uptime Kuma](https://github.com/louislam/uptime-kuma) with Ansible.\n\nPython version 3.7+ and Ansible version 2.9+ are required.\n\nSupported Uptime Kuma versions:\n\n| Uptime Kuma     | ansible-uptime-kuma | uptime-kuma-api |\n|-----------------|---------------------|-----------------|\n| 1.21.3 - 1.23.2 | 1.0.0 - 1.2.0       | 1.0.0+          |\n| 1.17.0 - 1.21.2 | 0.1.0 - 0.14.0      | 0.1.0 - 0.13.0  |\n\n\n## Installation\n\nThis collection requires the python module [uptime-kuma-api](https://github.com/lucasheld/uptime-kuma-api) to communicate with Uptime Kuma. It can be installed using pip:\n```shell\npip install uptime-kuma-api\n```\n\nAlternately, you can install a specific version (e.g. `0.13.0`):\n```shell\npip install uptime-kuma-api==0.13.0\n```\n\nThen install the ansible collection itself:\n```shell\nansible-galaxy collection install lucasheld.uptime_kuma\n```\n\nAlternately, you can install a specific version (e.g. `0.14.0`):\n```shell\nansible-galaxy collection install lucasheld.uptime_kuma:==0.14.0\n```\n\n## Modules\n\nThe following modules are available:\n\n- [api_key](https://github.com/lucasheld/ansible-uptime-kuma/wiki/api_key)\n- [api_key_info](https://github.com/lucasheld/ansible-uptime-kuma/wiki/api_key_info)\n- [docker_host](https://github.com/lucasheld/ansible-uptime-kuma/wiki/docker_host)\n- [docker_host_info](https://github.com/lucasheld/ansible-uptime-kuma/wiki/docker_host_info)\n- [game_list_info](https://github.com/lucasheld/ansible-uptime-kuma/wiki/game_list_info)\n- [login](https://github.com/lucasheld/ansible-uptime-kuma/wiki/login)\n- [maintenance](https://github.com/lucasheld/ansible-uptime-kuma/wiki/maintenance)\n- [maintenance_info](https://github.com/lucasheld/ansible-uptime-kuma/wiki/maintenance_info)\n- [monitor](https://github.com/lucasheld/ansible-uptime-kuma/wiki/monitor)\n- [monitor_info](https://github.com/lucasheld/ansible-uptime-kuma/wiki/monitor_info)\n- [monitor_tag](https://github.com/lucasheld/ansible-uptime-kuma/wiki/monitor_tag)\n- [notification](https://github.com/lucasheld/ansible-uptime-kuma/wiki/notification)\n- [notification_info](https://github.com/lucasheld/ansible-uptime-kuma/wiki/notification_info)\n- [proxy](https://github.com/lucasheld/ansible-uptime-kuma/wiki/proxy)\n- [proxy_info](https://github.com/lucasheld/ansible-uptime-kuma/wiki/proxy_info)\n- [settings](https://github.com/lucasheld/ansible-uptime-kuma/wiki/settings)\n- [settings_info](https://github.com/lucasheld/ansible-uptime-kuma/wiki/settings_info)\n- [setup](https://github.com/lucasheld/ansible-uptime-kuma/wiki/setup)\n- [status_page](https://github.com/lucasheld/ansible-uptime-kuma/wiki/status_page)\n- [status_page_info](https://github.com/lucasheld/ansible-uptime-kuma/wiki/status_page_info)\n- [tag](https://github.com/lucasheld/ansible-uptime-kuma/wiki/tag)\n- [tag_info](https://github.com/lucasheld/ansible-uptime-kuma/wiki/tag_info)\n\n\n## Getting started\nDirectly after the installation of Uptime Kuma, the initial username and password must be set:\n```yaml\n- name: Specify the initial username and password\n  lucasheld.uptime_kuma.setup:\n    api_url: http://127.0.0.1:3001\n    api_username: admin\n    api_password: secret123\n```\n\nFor future requests you can either use these credentials directly or a token that must be generated once.\nThe token usage is recommended because frequent logins lead to a rate limit. In this example we create a new monitor.\n\nOption 1 (not recommended): Create a monitor by using the credentials directly:\n```yaml\n- name: Login with credentials and create a monitor\n  lucasheld.uptime_kuma.monitor:\n    api_url: http://127.0.0.1:3001\n    api_username: admin\n    api_password: secret123\n    name: Google\n    type: http\n    url: https://google.com\n    state: present\n```\n\nOption 2 (recommended): Generate a token and create a monitor by using this token:\n```yaml\n- name: Login with credentials once and register the result\n  lucasheld.uptime_kuma.login:\n    api_url: http://127.0.0.1:3001\n    api_username: admin\n    api_password: secret123\n  register: result\n\n- name: Extract the token from the result and set it as fact\n  set_fact:\n    api_token: \"{{ result.token }}\"\n\n- name: Login by token and create a monitor\n  lucasheld.uptime_kuma.monitor:\n    api_url: http://127.0.0.1:3001\n    api_token: \"{{ api_token }}\"\n    name: Google\n    type: http\n    url: https://google.com\n    state: present\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucasheld%2Fansible-uptime-kuma","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flucasheld%2Fansible-uptime-kuma","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucasheld%2Fansible-uptime-kuma/lists"}