self hosted

CHANGELOG.rst

@@ -4,6 +4,11 @@ Community Healthchecks.io Release Notes
 
 .. contents:: Topics
 
+### [Unreleased]
+
+### Added
+
+- Support for using a private instance of Healthchecks.io
 
 v1.2.0
 ======

README.md

@@ -210,6 +210,22 @@ N/A
     signal: start
 ```
 
+### Using a Private Instance of Healthchecks.io
+
+The `api_base_url` variable allows you to specify the custom API URL of your healthchecks.io instance, which can be used to connect to your private instance.
+
+Example Ansible configuration using the `api_base_url` variable:
+
+```yaml
+- name: Create a check named "test"
+  community.healthchecksio.checks:
+    state: present
+    api_base_url: {{ api_base_url }}
+    api_key: "{{ api_key }}"
+    name: test
+    unique: ["name"]
+```
+
 ### Installing the Collection from Ansible Galaxy
 
 Before using this collection, you need to install it with the Ansible Galaxy command-line tool:

plugins/module_utils/healthchecksio.py

@@ -10,6 +10,7 @@
 from ansible.module_utils.urls import fetch_url
 from ansible.module_utils._text import to_text
 from ansible.module_utils.basic import env_fallback
+from urllib.parse import urljoin
 
 
 class Response(object):
@@ -42,7 +43,12 @@ def status_code(self):
 class HealthchecksioHelper:
     def __init__(self, module):
         self.module = module
-        self.baseurl = "https://healthchecks.io/api/v1"
+        api_base_url = module.params.get("api_base_url")
+        if api_base_url == self.healthchecksio_argument_spec().get("api_base_url").get("default"):
+            self.ping_api_base_url = "https://hc-ping.com"
+        else:
+            self.ping_api_base_url = urljoin(api_base_url, "/ping")
+        self.baseurl = urljoin(api_base_url, "/api/v1")
         self.timeout = module.params.get("timeout", 30)
         self.api_token = module.params.get("api_token")
         self.headers = {"X-Api-Key": self.api_token}
@@ -90,7 +96,7 @@ def delete(self, path, data=None):
     def head(self, path, data=None):
         resp, info = fetch_url(
             self.module,
-            "https://hc-ping.com/{0}".format(path),
+            "{0}/{1}".format(self.ping_api_base_url, path),
             data=data,
             headers=self.headers,
             method="HEAD",
@@ -117,6 +123,19 @@ def healthchecksio_argument_spec():
                 required=True,
                 no_log=True,
             ),
+            api_base_url=dict(
+                type="str",
+                fallback=(
+                    env_fallback,
+                    [
+                        "HEALTHCHECKSIO_API_BASE_URL",
+                        "HC_API_BASE_URL"
+                    ],
+                ),
+                required=False,
+                no_log=True,
+                default="https://healthchecks.io"
+            ),
         )
 
 
@@ -274,7 +293,7 @@ def __init__(self, module):
     def get_uuid(self, json_data):
         ping_url = json_data.get("ping_url", None)
         if ping_url is not None:
-            uuid = ping_url.split("/")[3]
+            uuid = ping_url.split("/")[-1]
             if len(uuid) > 0:
                 return uuid
             else: