You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 5, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: site/content/docs/api-checks/_index.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,12 +17,12 @@ Ensure your API is working properly with API checks. API checks work by sending
17
17
18
18

19
19
20
-
You can use these checks to verify that:
20
+
For example, you can use these checks to verify that:
21
21
* Your endpoint returns a 200 status code.
22
22
* Your endpoint responds with valid JSON that matches the expected schema.
23
23
* Your endpoint is properly authenticating requests.
24
24
25
-
If your endpoint is unresponsive or fails assertions, the check will trigger any configured alerts.
25
+
If your endpoint is unresponsive or fails assertions, the check will trigger any configured [alerts](/docs/alerting-and-retries/).
26
26
27
27
## Creating an API check
28
28
@@ -51,7 +51,7 @@ Setup scripts allow you to do last minute processing of test data and request op
51
51
52
52
### Response time limits
53
53
54
-
Sometimes APIs can be slow, but not broken. We call this **degraded**. You can set [response time limits](/docs/api-checks/limits/) to specify when an API check should be marked as **degraded** and when it should be marked as **failed**.
54
+
Sometimes APIs can be slow, but not broken. We call this degraded. You can set [response time limits](/docs/api-checks/limits/) to specify when an API check should be marked as degraded and when it should be marked as failed.
55
55
56
56
### Assertions
57
57
@@ -105,7 +105,7 @@ new ApiCheck('hello-api-1', {
105
105
106
106
The above example defines:
107
107
- The basic check properties like `name`, `activated` etc.
108
-
- The HTTP method `GET` the`url`.
108
+
- The `GET`HTTP method and target`url` of the request.
109
109
- An array of assertions to assert the HTTP response status is correct.
110
110
111
111
For more options, see the [Check construct reference](/docs/cli/constructs-reference/#check).
0 commit comments