This is early days for healtchecks.io REST API. For now, there's just -one API resource for listing/creating checks. +one API resource for listing and creating checks.
- Returns a list of checks + Returns a list of checks. This API call takes no parameters and returns + a JSON document with all checks in user's account.
-curl {{ SITE_ROOT }}/api/v1/checks/ \
- -X GET \
- -d '{"api_key": "your-api-key"}'
-
+{% include "front/snippets/list_checks_request.html" %}
-{"checks": [{"url": "{{ PING_ENDPOINT }}848f3002-266b-482a-89ad-9d66a11aa2fb", "grace": 900, "name": "API test 1", "timeout": 3600, "tags": "foo"}, {"url": "{{ PING_ENDPOINT }}20324f81-5966-4e75-9734-8440df52ed75", "grace": 60, "name": "API test 2", "timeout": 60, "tags": "bar,baz"}]}
-
+{% include "front/snippets/list_checks_response.html" %}
-curl {{ SITE_ROOT }}/api/v1/checks/ \
- -X POST \
- -d '{"api_key": "your-api-key", "name": "Backups", "tags": "prod www", "timeout": 3600, "grace": 60}'
-
+{% include "front/snippets/create_check_request.html" %}
-{"ping_url": "{{ PING_ENDPOINT }}20f2d3d0-efe4-4cc1-a114-a186a225de50"}
-
+{% include "front/snippets/create_check_response.html" %}
{% endblock %}
diff --git a/templates/front/snippets/bash.html b/templates/front/snippets/bash.html
index f3238c16..eedbea88 100644
--- a/templates/front/snippets/bash.html
+++ b/templates/front/snippets/bash.html
@@ -1,6 +1,6 @@
-# using curl:
+# using curl:
curl --retry 3 {{ ping_url }}
-# using wget:
+# using wget:
wget {{ ping_url }} -O /dev/null
diff --git a/templates/front/snippets/browser.html b/templates/front/snippets/browser.html
index 6f053e28..1f030cbd 100644
--- a/templates/front/snippets/browser.html
+++ b/templates/front/snippets/browser.html
@@ -1,4 +1,4 @@
-var xhr = new XMLHttpRequest();
+var xhr = new XMLHttpRequest();
xhr.open('GET', '{{ ping_url }}', true);
xhr.send(null);
diff --git a/templates/front/snippets/create_check_request.html b/templates/front/snippets/create_check_request.html
new file mode 100644
index 00000000..ce58ecf2
--- /dev/null
+++ b/templates/front/snippets/create_check_request.html
@@ -0,0 +1,4 @@
+curl http://localhost:8000/api/v1/checks/ \
+ -X POST \
+ -d '{"api_key": "your-api-key", "name": "Backups", "tags": "prod www", "timeout": 3600, "grace": 60}'
+
diff --git a/templates/front/snippets/create_check_request.txt b/templates/front/snippets/create_check_request.txt
new file mode 100644
index 00000000..92c077d0
--- /dev/null
+++ b/templates/front/snippets/create_check_request.txt
@@ -0,0 +1,3 @@
+curl http://localhost:8000/api/v1/checks/ \
+ -X POST \
+ -d '{"api_key": "your-api-key", "name": "Backups", "tags": "prod www", "timeout": 3600, "grace": 60}'
\ No newline at end of file
diff --git a/templates/front/snippets/create_check_response.html b/templates/front/snippets/create_check_response.html
new file mode 100644
index 00000000..0d76255d
--- /dev/null
+++ b/templates/front/snippets/create_check_response.html
@@ -0,0 +1,4 @@
+{
+ "ping_url": "{{ PING_ENDPOINT }}20f2d3d0-efe4-4cc1-a114-a186a225de50"
+}
+
diff --git a/templates/front/snippets/create_check_response.txt b/templates/front/snippets/create_check_response.txt
new file mode 100644
index 00000000..2dda1808
--- /dev/null
+++ b/templates/front/snippets/create_check_response.txt
@@ -0,0 +1,3 @@
+{
+ "ping_url": "PING_ENDPOINT20f2d3d0-efe4-4cc1-a114-a186a225de50"
+}
\ No newline at end of file
diff --git a/templates/front/snippets/crontab.html b/templates/front/snippets/crontab.html
index 07afc5d4..bd8e3fdf 100644
--- a/templates/front/snippets/crontab.html
+++ b/templates/front/snippets/crontab.html
@@ -1,3 +1,3 @@
-# m h dom mon dow command
+# m h dom mon dow command
8 6 * * * /home/user/backup.sh && curl -fsS --retry 3 {{ ping_url }} > /dev/null
diff --git a/templates/front/snippets/list_checks_request.html b/templates/front/snippets/list_checks_request.html
new file mode 100644
index 00000000..0998b652
--- /dev/null
+++ b/templates/front/snippets/list_checks_request.html
@@ -0,0 +1,4 @@
+curl {{ SITE_ROOT }}/api/v1/checks/ \
+ -X GET \
+ -d '{"api_key": "your-api-key"}'
+
diff --git a/templates/front/snippets/list_checks_request.txt b/templates/front/snippets/list_checks_request.txt
new file mode 100644
index 00000000..18f91aca
--- /dev/null
+++ b/templates/front/snippets/list_checks_request.txt
@@ -0,0 +1,3 @@
+curl SITE_ROOT/api/v1/checks/ \
+ -X GET \
+ -d '{"api_key": "your-api-key"}'
\ No newline at end of file
diff --git a/templates/front/snippets/list_checks_response.html b/templates/front/snippets/list_checks_response.html
new file mode 100644
index 00000000..d9b0da8c
--- /dev/null
+++ b/templates/front/snippets/list_checks_response.html
@@ -0,0 +1,19 @@
+{
+ "checks": [
+ {
+ "ping_url": "{{ PING_ENDPOINT }}848f3002-266b-482a-89ad-9d66a11aa2fb",
+ "grace": 900,
+ "name": "API test 1",
+ "timeout": 3600,
+ "tags": "foo"
+ },
+ {
+ "ping_url": "{{ PING_ENDPOINT }}20324f81-5966-4e75-9734-8440df52ed75",
+ "grace": 60,
+ "name": "API test 2",
+ "timeout": 60,
+ "tags": "bar,baz"
+ }
+ ]
+}
+
diff --git a/templates/front/snippets/list_checks_response.txt b/templates/front/snippets/list_checks_response.txt
new file mode 100644
index 00000000..08f62fdc
--- /dev/null
+++ b/templates/front/snippets/list_checks_response.txt
@@ -0,0 +1,18 @@
+{
+ "checks": [
+ {
+ "ping_url": "PING_ENDPOINT848f3002-266b-482a-89ad-9d66a11aa2fb",
+ "grace": 900,
+ "name": "API test 1",
+ "timeout": 3600,
+ "tags": "foo"
+ },
+ {
+ "ping_url": "PING_ENDPOINT20324f81-5966-4e75-9734-8440df52ed75",
+ "grace": 60,
+ "name": "API test 2",
+ "timeout": 60,
+ "tags": "bar,baz"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/templates/front/snippets/node.html b/templates/front/snippets/node.html
index f3b216a6..c2d2e703 100644
--- a/templates/front/snippets/node.html
+++ b/templates/front/snippets/node.html
@@ -1,3 +1,3 @@
-var http = require('http');
+var http = require('http');
http.get("{{ ping_url }}");
diff --git a/templates/front/snippets/php.html b/templates/front/snippets/php.html
index e30dec60..586b4af8 100644
--- a/templates/front/snippets/php.html
+++ b/templates/front/snippets/php.html
@@ -1,2 +1,2 @@
-file_get_contents('{{ ping_url }}');
+file_get_contents('{{ ping_url }}');
diff --git a/templates/front/snippets/powershell.html b/templates/front/snippets/powershell.html
index f238c946..a2b1a2ea 100644
--- a/templates/front/snippets/powershell.html
+++ b/templates/front/snippets/powershell.html
@@ -1,2 +1,2 @@
-Invoke-RestMethod {{ ping_url }}
+Invoke-RestMethod {{ ping_url }}
diff --git a/templates/front/snippets/python.html b/templates/front/snippets/python.html
index b60e49af..f75fd980 100644
--- a/templates/front/snippets/python.html
+++ b/templates/front/snippets/python.html
@@ -1,8 +1,8 @@
->>> # using urllib2:
+>>> # using urllib2:
>>> import urllib2
->>> urllib2.urlopen("{{ ping_url }}")
+>>> urllib2.urlopen("{{ ping_url }}")
->>> # using requests:
+>>> # using requests:
>>> import requests
->>> requests.get("{{ ping_url }}")
+>>> requests.get("{{ ping_url }}")