@ -103,12 +103,12 @@ specified value.</p>
< dd > The API key is either missing or invalid.< / dd >
< dd > The API key is either missing or invalid.< / dd >
< / dl >
< / dl >
< h3 > Example Request< / h3 >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > curl --header < span class = "s2" > " X-Api-Key: your-api-key" < / span > SITE_ROOT/api/v1/checks/
< div class = "bash 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 >
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< div class = "json highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< span class = "nt" > " checks" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "nt" > " checks" < / span > < span class = "p" > :< / 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 >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " Filesystem Backup" < / span > < span class = "p" > ,< / span >
@ -151,7 +151,7 @@ specified value.</p>
< p > When using the read-only API key, the following fields are omitted:
< 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
< 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 >
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 > < code > < span class = "p" > {< / span >
< div class = "json highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< span class = "nt" > " checks" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "nt" > " checks" < / span > < span class = "p" > :< / 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 >
< span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "s2" > " Filesystem Backup" < / span > < span class = "p" > ,< / span >
@ -203,12 +203,12 @@ using the read-only API key) as an identifier.</p>
< dd > The specified check does not exist.< / dd >
< dd > The specified check does not exist.< / dd >
< / dl >
< / dl >
< h3 > Example Request< / h3 >
< h3 > Example Request< / h3 >
< 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>
< div class = "bash 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 >
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< div class = "json 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" > " 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" > " 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 >
< 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 @@ 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
< 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
really secret. The client already knows the check's unique UUID and so can easily
construct these URLs by itself.< / p >
construct these URLs by itself.< / p >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< div class = "json 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" > " 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" > " 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 >
< span class = "nt" > " desc" < / span > < span class = "p" > :< / span > < span class = "s2" > " Runs ~/db-backup.sh" < / span > < span class = "p" > ,< / span >
@ -361,20 +361,20 @@ field values.</dd>
the limit is 20 checks per account.< / dd >
the limit is 20 checks per account.< / dd >
< / dl >
< / dl >
< h3 > Example Request< / h3 >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/ < span class = "se" > \< / span >
< div class = "bash 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 >
--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 >
--data < span class = "s1" > ' {" name" : " Backups" , " tags" : " prod www" , " timeout" : 3600, " grace" : 60}' < / span >
< / code > < / pre > < / div >
< / code > < / pre > < / div >
< p > Or, alternatively:< / p >
< p > Or, alternatively:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/ < span class = "se" > \< / span >
< div class = "bash 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 >
--data < span class = "s1" > ' {" api_key" : " your-api-key" , " name" : " Backups" , " tags" : " prod www" , " timeout" : 3600, " grace" : 60}' < / span >
< / code > < / pre > < / div >
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< div class = "json 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" > " 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" > " 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 >
< span class = "nt" > " grace" < / span > < span class = "p" > :< / span > < span class = "mi" > 60< / span > < span class = "p" > ,< / span >
@ -485,20 +485,20 @@ field values.</dd>
< dd > The specified check does not exist.< / dd >
< dd > The specified check does not exist.< / dd >
< / dl >
< / dl >
< h3 > Example Request< / h3 >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc < span class = "se" > \< / span >
< div class = "bash 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 >
--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 >
--data < span class = "s1" > ' {" name" : " Backups" , " tags" : " prod www" , " timeout" : 3600, " grace" : 60}' < / span >
< / code > < / pre > < / div >
< / code > < / pre > < / div >
< p > Or, alternatively:< / p >
< p > Or, alternatively:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc < span class = "se" > \< / span >
< div class = "bash 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 >
--data < span class = "s1" > ' {" api_key" : " your-api-key" , " name" : " Backups" , " tags" : " prod www" , " timeout" : 3600, " grace" : 60}' < / span >
< / code > < / pre > < / div >
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< div class = "json 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" > " 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" > " 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 >
< span class = "nt" > " grace" < / span > < span class = "p" > :< / span > < span class = "mi" > 60< / span > < span class = "p" > ,< / span >
@ -534,7 +534,7 @@ state. You can resume monitoring of the check by pinging it.</p>
< dd > The specified check does not exist.< / dd >
< dd > The specified check does not exist.< / dd >
< / dl >
< / dl >
< h3 > Example Request< / h3 >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/0c8983c9-9d73-446f-adb5-0641fdacc9d4/pause < span class = "se" > \< / span >
< div class = "bash 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 >
--request POST --header < span class = "s2" > " X-Api-Key: your-api-key" < / span > --data < span class = "s2" > " " < / span >
< / code > < / pre > < / div >
< / code > < / pre > < / div >
@ -543,7 +543,7 @@ state. You can resume monitoring of the check by pinging it.</p>
even though the request body is empty. For HTTP POST requests, the < code > Content-Length< / code >
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 >
header is sometimes required by some network proxies and web servers.< / p >
< h3 > Example Response< / h3 >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< div class = "json 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" > " 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" > " 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 >
< span class = "nt" > " grace" < / span > < span class = "p" > :< / span > < span class = "mi" > 60< / span > < span class = "p" > ,< / span >
@ -579,13 +579,13 @@ check that was just deleted.</p>
< dd > The specified check does not exist.< / dd >
< dd > The specified check does not exist.< / dd >
< / dl >
< / dl >
< h3 > Example Request< / h3 >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc < span class = "se" > \< / span >
< div class = "bash 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 >
--request DELETE --header < span class = "s2" > " X-Api-Key: your-api-key" < / span >
< / code > < / pre > < / div >
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< div class = "json 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" > " 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" > " 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 >
< span class = "nt" > " grace" < / span > < span class = "p" > :< / span > < span class = "mi" > 60< / span > < span class = "p" > ,< / span >
@ -622,13 +622,13 @@ number of returned pings depends on account's billing plan: 100 for free account
< dd > The specified check does not exist.< / dd >
< dd > The specified check does not exist.< / dd >
< / dl >
< / dl >
< h3 > Example Request< / h3 >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc/pings/ < span class = "se" > \< / span >
< div class = "bash 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 >
--header < span class = "s2" > " X-Api-Key: your-api-key" < / span >
< / code > < / pre > < / div >
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< div class = "json highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< span class = "nt" > " pings" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "nt" > " pings" < / span > < span class = "p" > :< / 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 >
< span class = "nt" > " type" < / span > < span class = "p" > :< / span > < span class = "s2" > " success" < / span > < span class = "p" > ,< / span >
@ -713,13 +713,13 @@ number of returned pings depends on account's billing plan: 100 for free account
< dd > The specified check does not exist.< / dd >
< dd > The specified check does not exist.< / dd >
< / dl >
< / dl >
< h3 > Example Request< / h3 >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > curl SITE_ROOT/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc/flips/ < span class = "se" > \< / span >
< div class = "bash 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 >
--header < span class = "s2" > " X-Api-Key: your-api-key" < / span >
< / code > < / pre > < / div >
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > [< / span >
< div class = "json highlight" > < pre > < span > < / span > < code > < span class = "p" > [< / span >
< 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" > " 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 >
< span class = "nt" > " up" < / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span >
@ -747,12 +747,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 >
< dd > The API key is either missing or invalid.< / dd >
< / dl >
< / dl >
< h3 > Example Request< / h3 >
< h3 > Example Request< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > curl --header < span class = "s2" > " X-Api-Key: your-api-key" < / span > SITE_ROOT/api/v1/channels/
< div class = "bash 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 >
< / code > < / pre > < / div >
< h3 > Example Response< / h3 >
< h3 > Example Response< / h3 >
< div class = "highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< div class = "json highlight" > < pre > < span > < / span > < code > < span class = "p" > {< / span >
< span class = "nt" > " channels" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< span class = "nt" > " channels" < / span > < span class = "p" > :< / 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 >
< span class = "nt" > " id" < / span > < span class = "p" > :< / span > < span class = "s2" > " 4ec5a071-2d08-4baa-898a-eb4eb3cd6941" < / span > < span class = "p" > ,< / span >