@ -113,12 +113,12 @@ specified value.</p>
< dd > The API key is either missing or invalid.< / dd >
< / dl >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > curl --header < span class = "s2" > " X-Api-Key: your-api-key" < / span > SITE_ROOT/api/v1/checks/
< / pre > < / div >
< div class = "highlight" > < pre > < span > < / span > < code > curl --header < span class = "s2" > " X-Api-Key: your-api-key" < / span > SITE_ROOT/api/v1/checks/
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< span class = "nt" > " checks" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "p" > {< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " Filesystem Backup" < / span > < span class = "p" > ,< / span >
@ -155,13 +155,13 @@ specified value.</p>
< span class = "p" > }< / span >
< span class = "p" > ]< / span >
< span class = "p" > }< / span >
< / pre > < / div >
< / code > < / pre > < / div >
< p > When using the read-only API key, the following fields are omitted:
< code > ping_url< / code > , < code > update_url< / code > , < code > pause_url< / code > , < code > channels< / code > . An extra < code > unique_key< / code > field
is added which can be used < a href = "#get-check" > to < code > GET< / code > a check< / a > in place of the < code > UUID< / code > . The < code > unique_key< / code > identifier is stable across API calls. Example:< / p >
< div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< span class = "nt" > " checks" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "p" > {< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " Filesystem Backup" < / span > < span class = "p" > ,< / span >
@ -192,7 +192,7 @@ is added which can be used <a href="#get-check">to <code>GET</code> a check</a>
< span class = "p" > }< / span >
< span class = "p" > ]< / span >
< span class = "p" > }< / span >
< / pre > < / div >
< / code > < / pre > < / div >
< h2 class = "rule" id = "get-check" > Get a Single Check< / h2 >
@ -213,12 +213,12 @@ using the read-only API key) as an identifier.</p>
< dd > The specified check does not exist.< / dd >
< / dl >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > curl --header < span class = "s2" > " X-Api-Key: your-api-key" < / span > SITE_ROOT/api/v1/checks/< uuid>
< / pre > < / div >
< div class = "highlight" > < pre > < span > < / span > < code > curl --header < span class = "s2" > " X-Api-Key: your-api-key" < / span > SITE_ROOT/api/v1/checks/< uuid>
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " Database Backup" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " tags" < / span > < span class = "p" > :< / span > < span class = "s2" > " production db" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " desc" < / span > < span class = "p" > :< / span > < span class = "s2" > " Runs ~/db-backup.sh" < / span > < span class = "p" > ,< / span >
@ -235,7 +235,7 @@ using the read-only API key) as an identifier.</p>
< span class = "nt" > " schedule" < / span > < span class = "p" > :< / span > < span class = "s2" > " 15 5 * * *" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " tz" < / span > < span class = "p" > :< / span > < span class = "s2" > " UTC" < / span >
< span class = "p" > }< / span >
< / pre > < / div >
< / code > < / pre > < / div >
< h3 > Example Read-Only Response< / h3 >
@ -245,7 +245,7 @@ added. This identifier is stable across API calls.</p>
< p > Note: the < code > ping_url< / code > , < code > update_url< / code > and < code > pause_url< / code > fields, although omitted, are not
really secret. The client already knows the check's unique UUID and so can easily
construct these URLs by itself.< / p >
< div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " Database Backup" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " tags" < / span > < span class = "p" > :< / span > < span class = "s2" > " production db" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " desc" < / span > < span class = "p" > :< / span > < span class = "s2" > " Runs ~/db-backup.sh" < / span > < span class = "p" > ,< / span >
@ -259,7 +259,7 @@ construct these URLs by itself.</p>
< span class = "nt" > " schedule" < / span > < span class = "p" > :< / span > < span class = "s2" > " 15 5 * * *" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " tz" < / span > < span class = "p" > :< / span > < span class = "s2" > " UTC" < / span >
< span class = "p" > }< / span >
< / pre > < / div >
< / code > < / pre > < / div >
< h2 class = "rule" id = "create-check" > Create a Check< / h2 >
@ -371,20 +371,20 @@ field values.</dd>
the limit is 20 checks per account.< / dd >
< / dl >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > curl SITE_ROOT/api/v1/checks/ < span class = "se" > \< / span >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/ < span class = "se" > \< / span >
--header < span class = "s2" > " X-Api-Key: your-api-key" < / span > < span class = "se" > \< / span >
--data < span class = "s1" > ' {" name" : " Backups" , " tags" : " prod www" , " timeout" : 3600, " grace" : 60}' < / span >
< / pre > < / div >
< / code > < / pre > < / div >
< p > Or, alternatively:< / p >
< div class = "highlight" > < pre > < span > < / span > curl SITE_ROOT/api/v1/checks/ < span class = "se" > \< / span >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/ < span class = "se" > \< / span >
--data < span class = "s1" > ' {" api_key" : " your-api-key" , " name" : " Backups" , " tags" : " prod www" , " timeout" : 3600, " grace" : 60}' < / span >
< / pre > < / div >
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< span class = "nt" > " channels" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< span class = "nt" > " desc" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< span class = "nt" > " grace" < / span > < span class = "p" > :< / span > < span class = "mi" > 60< / span > < span class = "p" > ,< / span >
@ -400,7 +400,7 @@ the limit is 20 checks per account.</dd>
< span class = "nt" > " timeout" < / span > < span class = "p" > :< / span > < span class = "mi" > 3600< / span > < span class = "p" > ,< / span >
< span class = "nt" > " update_url" < / span > < span class = "p" > :< / span > < span class = "s2" > " SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc" < / span > < span class = "p" > ,< / span >
< span class = "p" > }< / span >
< / pre > < / div >
< / code > < / pre > < / div >
< h2 class = "rule" id = "update-check" > Update an Existing Check< / h2 >
@ -495,20 +495,20 @@ field values.</dd>
< dd > The specified check does not exist.< / dd >
< / dl >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc < span class = "se" > \< / span >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc < span class = "se" > \< / span >
--header < span class = "s2" > " X-Api-Key: your-api-key" < / span > < span class = "se" > \< / span >
--data < span class = "s1" > ' {" name" : " Backups" , " tags" : " prod www" , " timeout" : 3600, " grace" : 60}' < / span >
< / pre > < / div >
< / code > < / pre > < / div >
< p > Or, alternatively:< / p >
< div class = "highlight" > < pre > < span > < / span > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc < span class = "se" > \< / span >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc < span class = "se" > \< / span >
--data < span class = "s1" > ' {" api_key" : " your-api-key" , " name" : " Backups" , " tags" : " prod www" , " timeout" : 3600, " grace" : 60}' < / span >
< / pre > < / div >
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< span class = "nt" > " channels" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< span class = "nt" > " desc" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< span class = "nt" > " grace" < / span > < span class = "p" > :< / span > < span class = "mi" > 60< / span > < span class = "p" > ,< / span >
@ -524,7 +524,7 @@ field values.</dd>
< span class = "nt" > " timeout" < / span > < span class = "p" > :< / span > < span class = "mi" > 3600< / span > < span class = "p" > ,< / span >
< span class = "nt" > " update_url" < / span > < span class = "p" > :< / span > < span class = "s2" > " SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc" < / span > < span class = "p" > ,< / span >
< span class = "p" > }< / span >
< / pre > < / div >
< / code > < / pre > < / div >
< h2 class = "rule" id = "pause-check" > Pause Monitoring of a Check< / h2 >
@ -544,16 +544,16 @@ state. You can resume monitoring of the check by pinging it.</p>
< dd > The specified check does not exist.< / dd >
< / dl >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > curl SITE_ROOT/api/v1/checks/0c8983c9-9d73-446f-adb5-0641fdacc9d4/pause < span class = "se" > \< / span >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/0c8983c9-9d73-446f-adb5-0641fdacc9d4/pause < span class = "se" > \< / span >
--request POST --header < span class = "s2" > " X-Api-Key: your-api-key" < / span > --data < span class = "s2" > " " < / span >
< / pre > < / div >
< / code > < / pre > < / div >
< p > Note: the < code > --data ""< / code > argument forces curl to send a < code > Content-Length< / code > request header
even though the request body is empty. For HTTP POST requests, the < code > Content-Length< / code >
header is sometimes required by some network proxies and web servers.< / p >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< span class = "nt" > " channels" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< span class = "nt" > " desc" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< span class = "nt" > " grace" < / span > < span class = "p" > :< / span > < span class = "mi" > 60< / span > < span class = "p" > ,< / span >
@ -569,7 +569,7 @@ header is sometimes required by some network proxies and web servers.</p>
< span class = "nt" > " timeout" < / span > < span class = "p" > :< / span > < span class = "mi" > 3600< / span > < span class = "p" > ,< / span >
< span class = "nt" > " update_url" < / span > < span class = "p" > :< / span > < span class = "s2" > " SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc" < / span >
< span class = "p" > }< / span >
< / pre > < / div >
< / code > < / pre > < / div >
< h2 class = "rule" id = "delete-check" > Delete Check< / h2 >
@ -589,13 +589,13 @@ check that was just deleted.</p>
< dd > The specified check does not exist.< / dd >
< / dl >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc < span class = "se" > \< / span >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc < span class = "se" > \< / span >
--request DELETE --header < span class = "s2" > " X-Api-Key: your-api-key" < / span >
< / pre > < / div >
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< span class = "nt" > " channels" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< span class = "nt" > " desc" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< span class = "nt" > " grace" < / span > < span class = "p" > :< / span > < span class = "mi" > 60< / span > < span class = "p" > ,< / span >
@ -611,7 +611,7 @@ check that was just deleted.</p>
< span class = "nt" > " timeout" < / span > < span class = "p" > :< / span > < span class = "mi" > 3600< / span > < span class = "p" > ,< / span >
< span class = "nt" > " update_url" < / span > < span class = "p" > :< / span > < span class = "s2" > " SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc" < / span > < span class = "p" > ,< / span >
< span class = "p" > }< / span >
< / pre > < / div >
< / code > < / pre > < / div >
< h2 class = "rule" id = "list-pings" > Get a list of check's logged pings< / h2 >
@ -632,13 +632,13 @@ number of returned pings depends on account's billing plan: 100 for free account
< dd > The specified check does not exist.< / dd >
< / dl >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc/pings/ < span class = "se" > \< / span >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc/pings/ < span class = "se" > \< / span >
--header < span class = "s2" > " X-Api-Key: your-api-key" < / span >
< / pre > < / div >
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< span class = "nt" > " pings" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "p" > {< / span >
< span class = "nt" > " type" < / span > < span class = "p" > :< / span > < span class = "s2" > " success" < / span > < span class = "p" > ,< / span >
@ -680,7 +680,7 @@ number of returned pings depends on account's billing plan: 100 for free account
< span class = "p" > }< / span >
< span class = "p" > ]< / span >
< span class = "p" > }< / span >
< / pre > < / div >
< / code > < / pre > < / div >
< h2 class = "rule" id = "list-flips" > Get a list of check's status changes< / h2 >
@ -723,13 +723,13 @@ number of returned pings depends on account's billing plan: 100 for free account
< dd > The specified check does not exist.< / dd >
< / dl >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc/flips/ < span class = "se" > \< / span >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc/flips/ < span class = "se" > \< / span >
--header < span class = "s2" > " X-Api-Key: your-api-key" < / span >
< / pre > < / div >
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < span class = "p" > [< / span >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > [< / span >
< span class = "p" > {< / span >
< span class = "nt" > " timestamp" < / span > < span class = "p" > :< / span > < span class = "s2" > " 2020-03-23T10:18:23+00:00" < / span > < span class = "p" > ,< / span >
< span class = "nt" > " up" < / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span >
@ -743,7 +743,7 @@ number of returned pings depends on account's billing plan: 100 for free account
< span class = "nt" > " up" < / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span >
< span class = "p" > }< / span >
< span class = "p" > ]< / span >
< / pre > < / div >
< / code > < / pre > < / div >
< h2 class = "rule" id = "list-channels" > Get a List of Existing Integrations< / h2 >
@ -757,12 +757,12 @@ number of returned pings depends on account's billing plan: 100 for free account
< dd > The API key is either missing or invalid.< / dd >
< / dl >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > curl --header < span class = "s2" > " X-Api-Key: your-api-key" < / span > SITE_ROOT/api/v1/channels/
< / pre > < / div >
< div class = "highlight" > < pre > < span > < / span > < code > curl --header < span class = "s2" > " X-Api-Key: your-api-key" < / span > SITE_ROOT/api/v1/channels/
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< span class = "nt" > " channels" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "p" > {< / span >
< span class = "nt" > " id" < / span > < span class = "p" > :< / span > < span class = "s2" > " 4ec5a071-2d08-4baa-898a-eb4eb3cd6941" < / span > < span class = "p" > ,< / span >
@ -776,4 +776,4 @@ number of returned pings depends on account's billing plan: 100 for free account
< span class = "p" > }< / span >
< span class = "p" > ]< / span >
< span class = "p" > }< / span >
< / pre > < / div >
< / code > < / pre > < / div >