diff --git a/templates/docs/api.html b/templates/docs/api.html index 21cfc6c7..f26c6caf 100644 --- a/templates/docs/api.html +++ b/templates/docs/api.html @@ -148,6 +148,8 @@ specified value.
} +The possible values for the status
field are: new
, started
, up
, grace
, down
,
+and paused
.
When using the read-only API key, SITE_NAME omits the following fields from responses:
ping_url
, update_url
, pause_url
, channels
. It adds an extra
unique_key
field. The unique_key
identifier is stable across API calls, and
@@ -231,6 +233,8 @@ using the read-only API key) as an identifier.
The possible values for the status
field are: new
, started
, up
, grace
, down
,
+and paused
.
When using the read-only API key, SITE_NAME omits the following fields from responses:
SITE_NAME sends monthly email reports at the start of each month. Use them
-to make sure all checks have their expected state, and nothing has
-"fallen through the cracks." A monthly report shows checks from all your projects.
-For each check, it lists: SITE_NAME sends periodic email reports, either monthly at the start of each month,
+or weekly every Monday. Use them to make sure all checks have their expected state,
+and nothing has "fallen through the cracks." The reports list checks from all your projects, grouped by project.
+For each check, they show: You can opt-out from the monthly reports in the
+ You can opt-out from receiving the the reports in the
Account Settings › Email Reports page
or by clicking the "Unsubscribe" link in the email report's footer.ping_url
, update_url
, pause_url
, channels
. It adds an extra
diff --git a/templates/docs/api.md b/templates/docs/api.md
index dee6cbbb..99d6b5b7 100644
--- a/templates/docs/api.md
+++ b/templates/docs/api.md
@@ -132,6 +132,9 @@ curl --header "X-Api-Key: your-api-key" SITE_ROOT/api/v1/checks/
}
```
+The possible values for the `status` field are: `new`, `started`, `up`, `grace`, `down`,
+and `paused`.
+
When using the read-only API key, SITE_NAME omits the following fields from responses:
`ping_url`, `update_url`, `pause_url`, `channels`. It adds an extra
`unique_key` field. The `unique_key` identifier is stable across API calls, and
@@ -228,6 +231,9 @@ curl --header "X-Api-Key: your-api-key" SITE_ROOT/api/v1/checks/Monthly Reports
-Weekly and Monthly Reports
+
-